Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLSceneInfo Class Reference

#include <SceneInfo.h>

Inheritance diagram for CSLSceneInfo::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

CSLSceneInfo Class

Describes the SceneInformation template.


Constructor & Destructor Documentation

CSLSceneInfo::CSLSceneInfo CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate,
CSLSceneInfo::ETimingType    in_DefaultTimingType = 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

SI_Float CSLSceneInfo::GetEnd  
 

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

Returns:
SI_Int End frame

SI_Float CSLSceneInfo::GetFrameRate  
 

Get frames per second.

Returns:
SI_Float Current frame rate

SI_Float CSLSceneInfo::GetStart  
 

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

Returns:
The current start frame

CSLSceneInfo::ETimingType CSLSceneInfo::GetTimingType  
 

Get the timing type.

Returns:
Current timing type

CSLAnimatableType * CSLSceneInfo::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.

void CSLSceneInfo::SetEnd SI_Float    in_nEnd
 

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

Parameters:
in_nEnd  New end frame to use

void CSLSceneInfo::SetFrameRate SI_Float    in_fFrameRate
 

Set frames per second.

Parameters:
in_fFrameRate  New frame rate to use

void CSLSceneInfo::SetStart SI_Float    in_nStart
 

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

Parameters:
in_nStart  New start frame to use

void CSLSceneInfo::SetTimingType ETimingType    in_Type [inline]
 

Set the timing type.

Parameters:
in_Type  New timing type to use

CSLTemplate::ETemplateType CSLSceneInfo::Type   [virtual]
 

Indicate which dotXSI template this object describes.

Returns:
ETemplateType Type of template

Reimplemented from CSLTemplate.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.