PixelLightAPI  .
Public Member Functions
PLRenderer::AnimationEvent Class Reference

Animation event. More...

#include <AnimationEvent.h>

Inheritance diagram for PLRenderer::AnimationEvent:
Inheritance graph
[legend]

List of all members.

Public Member Functions

PLRENDERER_API AnimationEvent (int nID, PLCore::uint32 nFrame, AnimationEventManager *pManager=nullptr, const PLCore::String &sName="")
 Constructor.
int GetID () const
 Returns the event ID.
void SetID (int nID)
 Sets the event ID.
PLCore::uint32 GetFrame () const
 Returns the frame which will cause this event.
void SetFrame (PLCore::uint32 nFrame)
 Sets the frame causing this event.
virtual PLRENDERER_API
AnimationEvent
operator= (const AnimationEvent &cSource)

Detailed Description

Animation event.


Constructor & Destructor Documentation

PLRENDERER_API PLRenderer::AnimationEvent::AnimationEvent ( int  nID,
PLCore::uint32  nFrame,
AnimationEventManager pManager = nullptr,
const PLCore::String sName = "" 
)

Constructor.

Parameters:
[in]nIDEvent ID
[in]nFrameFrame causing this event
[in]pManagerEvent manager using this element, can be a null pointer
[in]sNameName of the event, if empty, a default name is set automatically
Note:
  • If you provide the pointer to the owner manager the animation event will check in the animation event manager name list

Member Function Documentation

int PLRenderer::AnimationEvent::GetID ( ) const [inline]

Returns the event ID.

Returns:
Event ID

Reimplemented from PLCore::Element< AnimationEvent >.

void PLRenderer::AnimationEvent::SetID ( int  nID) [inline]

Sets the event ID.

Parameters:
[in]nIDEvent ID
PLCore::uint32 PLRenderer::AnimationEvent::GetFrame ( ) const [inline]

Returns the frame which will cause this event.

Returns:
The frame which will cause this event
void PLRenderer::AnimationEvent::SetFrame ( PLCore::uint32  nFrame) [inline]

Sets the frame causing this event.

Parameters:
[in]nFrameFrame causing this event
virtual PLRENDERER_API AnimationEvent& PLRenderer::AnimationEvent::operator= ( const AnimationEvent cSource) [virtual]

The documentation for this class was generated from the following files:


PixelLight PixelLight 0.9.10-R1
Copyright (C) 2002-2011 by The PixelLight Team
Last modified Fri Dec 23 2011 15:51:22
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported