CSLSceneInfo Class Reference

This class represents the SI_SceneInfo template. More...

#include <SceneInfo.h>

Inheritance diagram for CSLSceneInfo:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   ETimingType

Public Member Functions
  CSLSceneInfo (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate, ETimingType in_DefaultETimingType=SI_FRAMES)
virtual  ~CSLSceneInfo ()
void  SetEnd (SI_Float in_nEnd)
SI_Float  GetEnd ()
void  SetFrameRate (SI_Float in_fFrameRate)
SI_Float  GetFrameRate ()
void  SetStart (SI_Float in_nStart)
SI_Float  GetStart ()
void  SetTimingType (ETimingType in_Type)
ETimingType  GetTimingType ()
virtual CSLTemplate::ETemplateType  Type ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)

Detailed Description

This class represents the SI_SceneInfo template.

Base class to handle timing information for the scene (see the SI_SceneInfo template reference).

Member Enumeration Documentation

enum ETimingType

Enumeration specifying the timing type

Constructor & Destructor Documentation

CSLSceneInfo ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate,
ETimingType  in_DefaultETimingType = SI_FRAMES  
)

Constructor

Parameters:
[in]  in_pScene  Pointer to the scene
[in]  in_pModel  Pointer to the model
[in]  in_pTemplate  Pointer to the parent template
[in]  in_DefaultETimingType  Timing type to use if an invalid type is loaded

virtual ~CSLSceneInfo (  )  [virtual]

Destructor

Member Function Documentation

void SetEnd ( SI_Float  in_nEnd  ) 

Sets end time of the scene (Time type specified by ETimingType)

Parameters:
[in]  in_nEnd  New end frame to use

SI_Float GetEnd (  ) 

Returns end time of the scene (Time type specified by ETimingType)

Returns:
End frame

void SetFrameRate ( SI_Float  in_fFrameRate  ) 

Sets frames per second

Parameters:
[in]  in_fFrameRate  New frame rate to use

SI_Float GetFrameRate (  ) 

Returns frames per second

Returns:
Current frame rate

void SetStart ( SI_Float  in_nStart  ) 

Sets Start time of the scene (Time type specified by ETimingType)

Parameters:
[in]  in_nStart  New start frame to use

SI_Float GetStart (  ) 

Returns Start time of the scene (Time type specified by ETimingType)

Returns:
The current start frame

void SetTimingType ( ETimingType  in_Type  ) 

Sets the timing type

Parameters:
[in]  in_Type  New timing type to use

ETimingType GetTimingType (  ) 

Returns the timing type

Returns:
Current timing type

virtual CSLTemplate::ETemplateType Type (  )  [virtual]

Returns the template type

Return values:
CSLTemplate::SI_SCENE_INFO  Type of template

Implements CSLTemplate.

virtual CSLAnimatableType* ParameterFromName ( SI_Char *  in_szName  )  [virtual]

Returns a proxy to the specified parameter.

Parameters:
[in]  in_szName  Name of the parameter
Returns:
Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

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