CSLSceneInfo Class Reference

#include <SceneInfo.h>

Inheritance diagram for CSLSceneInfo:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   ETimingType
  Enumeration specifying the timing type.

Public Member Functions
  CSLSceneInfo (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate, ETimingType in_DefaultETimingType=SI_FRAMES)
  Constructor.
virtual  ~CSLSceneInfo ()
  Destructor.
void  SetEnd (SI_Float in_nEnd)
  Set end time of the scene (Time type specified by ETimingType).
SI_Float  GetEnd ()
  Get end time of the scene (Time type specified by ETimingType).
void  SetFrameRate (SI_Float in_fFrameRate)
  Set frames per second.
SI_Float  GetFrameRate ()
  Get frames per second.
void  SetStart (SI_Float in_nStart)
  Set Start time of the scene (Time type specified by ETimingType).
SI_Float  GetStart ()
  Get Start time of the scene (Time type specified by ETimingType).
void  SetTimingType (ETimingType in_Type)
  Set the timing type.
ETimingType  GetTimingType ()
  Get the timing type.
virtual CSLTemplate::ETemplateType  Type ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)

Detailed Description

Describes the SceneInformation.

Constructor & Destructor Documentation

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

Constructor.

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

Member Function Documentation

void SetEnd ( SI_Float  in_nEnd  ) 

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

Parameters:
in_nEnd  New end frame to use

SI_Float GetEnd (  ) 

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

Returns:
SI_Int End frame

void SetFrameRate ( SI_Float  in_fFrameRate  ) 

Set frames per second.

Parameters:
in_fFrameRate  New frame rate to use

SI_Float GetFrameRate (  ) 

Get frames per second.

Returns:
SI_Float Current frame rate

void SetStart ( SI_Float  in_nStart  ) 

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

Parameters:
in_nStart  New start frame to use

SI_Float GetStart (  ) 

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

Returns:
The current start frame

void SetTimingType ( ETimingType  in_Type  ) 

Set the timing type.

Parameters:
in_Type  New timing type to use

ETimingType GetTimingType (  ) 

Get the timing type.

Returns:
Current timing type

virtual CSLTemplate::ETemplateType Type (  )  [virtual]

Indicate which dotXSI template this object describes.

Returns:
ETemplateType Type of template

Implements CSLTemplate.

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

Return a proxy to the specified parameter.

Parameters:
in_szName  Name of the parameter
Returns:
CSLAnimatableType* Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

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