Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLSpotLight Class Reference

Describes a spot light and its interest. More...

#include <SpotLight.h>

Inheritance diagram for CSLSpotLight::

CSLLight CSLPrimitive CSLConstrainableType CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

Describes a spot light and its interest.


Constructor & Destructor Documentation

CSLSpotLight::CSLSpotLight CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate
 

Constructor

Parameters:
in_pScene  scene to add this spotlight to
in_pModel  model to add this light to
in_pTemplate  IO layer template to connect to
Returns:
an instance of CSLSpotLight

CSLSpotLight::~CSLSpotLight   [virtual]
 

Destructor


Member Function Documentation

SI_Float CSLSpotLight::GetConeAngle  
 

Return the cone angle of the spotlight.

Returns:
SI_Float Cone angle.

CSIBCVector3D CSLSpotLight::GetInterestPosition  
 

Return the position of the spotlight interest.

Returns:
CSIBCVector3D Interest position.

SI_Float CSLSpotLight::GetSpreadAngle  
 

Return the spread angle of the spotlight.

Returns:
SI_Float Spread angle.

CSLAnimatableType * CSLSpotLight::ParameterFromName SI_Char *    in_szName [virtual]
 

Gets a handle on one of this light's parameters by using its name

Parameters:
in_szName  the name of the parameter to get the handle from
Returns:
CSLAnimatableType* the handle to the parameter

Reimplemented from CSLLight.

CSLAnimatableType * CSLSpotLight::ParameterFromType EFCurveType    in_Type,
SI_Char *    in_szParameterName
[virtual]
 

Gets a handle on one of this light's parameters by using its name and type

Parameters:
in_szName  the name of the parameter to get the handle from
in_Type  the type of the parameter to get the handle from
Returns:
CSLAnimatableType* the handle to the parameter

Reimplemented from CSLLight.

SI_Void CSLSpotLight::SetConeAngle SI_Float    in_fValue
 

Change the cone angle of the spotlight.

Parameters:
in_fValue  New cone angle.
Returns:
None

SI_Void CSLSpotLight::SetInterestPosition CSIBCVector3D   in_rValue
 

Change the position of the spotlight interest.

Parameters:
in_rValue  New interest position.
Returns:
SI_Void

SI_Void CSLSpotLight::SetSpreadAngle SI_Float    in_fValue
 

Change the spread angle of the spotlight.

Parameters:
in_fValue  New spread angle.
Returns:
SI_Void

SI_Error CSLSpotLight::Synchronize   [virtual]
 

Synchronizes this light instance with its IO layer representation

Returns:
SI_Error
Return values:
SI_SUCCESS  this function always returns SI_SUCCESS

Reimplemented from CSLLight.

CSLTemplate::ETemplateType CSLSpotLight::Type   [virtual]
 

Get the template type

Returns:
ETemplateType the template type of the spotlight

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.