Torque3D Documentation / _generateds / VLightObjectAnimationEvent.cpp

VLightObjectAnimationEvent.cpp

Engine/source/Verve/Extension/LightObject/VLightObjectAnimationEvent.cpp

More...

Detailed Description

Public Functions

IMPLEMENT_CONOBJECT(VLightObjectAnimationEvent )

 1
 2//-----------------------------------------------------------------------------
 3// Verve
 4// Copyright (C) 2014 - Violent Tulip
 5//
 6// Permission is hereby granted, free of charge, to any person obtaining a copy
 7// of this software and associated documentation files (the "Software"), to
 8// deal in the Software without restriction, including without limitation the
 9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10// sell copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12//
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15//
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22// IN THE SOFTWARE.
23//-----------------------------------------------------------------------------
24#include "Verve/Extension/LightObject/VLightObjectAnimationEvent.h"
25
26#include "console/consoleTypes.h"
27
28//-----------------------------------------------------------------------------
29IMPLEMENT_CONOBJECT( VLightObjectAnimationEvent );
30//-----------------------------------------------------------------------------
31
32//-----------------------------------------------------------------------------
33
34VLightObjectAnimationEvent::VLightObjectAnimationEvent( void ) : 
35        mAnimationData( NULL )
36{
37    setLabel( "AnimationEvent" );
38}
39
40void VLightObjectAnimationEvent::initPersistFields( void )
41{
42    Parent::initPersistFields();
43
44    addField( "AnimationData", TYPEID<VTorque::LightAnimationDataType>(), Offset( mAnimationData, VLightObjectAnimationEvent ) );
45}
46
47//-----------------------------------------------------------------------------
48//
49// Callback Methods.
50//
51//-----------------------------------------------------------------------------
52
53//-----------------------------------------------------------------------------
54// 
55// VLightObjectAnimationEvent::onTrigger( pTime, pDelta );
56// 
57// When this Event is triggered the light object will begin to play the target
58// animation.
59// 
60//-----------------------------------------------------------------------------
61void VLightObjectAnimationEvent::onTrigger( const S32 &pTime, const S32 &pDelta )
62{
63    Parent::onTrigger( pTime, pDelta );
64
65    // Fetch the Light Object.
66    VTorque::LightObjectType *lightObject;
67    if ( getSceneObject( lightObject ) )
68    {
69        // Play the Animation.
70        VTorque::playAnimation( lightObject, mAnimationData );
71    }
72}
73
74//-----------------------------------------------------------------------------
75// 
76// VLightObjectAnimationEvent::onComplete( pTime, pDelta );
77// 
78// The current animation played by the light object will be paused when this
79// Event completes its updates.
80// 
81//-----------------------------------------------------------------------------
82void VLightObjectAnimationEvent::onComplete( const S32 &pTime, const S32 &pDelta )
83{
84    Parent::onTrigger( pTime, pDelta );
85
86    // Fetch the Light Object.
87    VTorque::LightObjectType *lightObject;
88    if ( getSceneObject( lightObject ) )
89    {
90        // Pause the Animation.
91        VTorque::pauseAnimation( lightObject );
92    }
93}
94