Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLLight Class Reference

Base class for lights. More...

#include <Light.h>

Inheritance diagram for CSLLight::

CSLPrimitive CSLConstrainableType CSLTemplate CSIBCNode CSLDirectionalLight CSLInfiniteLight CSLPointLight CSLSpotLight List of all members.

Public Methods


Detailed Description

Base class for lights.


Constructor & Destructor Documentation

CSLLight::~CSLLight   [virtual]
 

Destructor


Member Function Documentation

CSLConstraint * CSLLight::AddConstraint CSLConstraint::EConstraintType    in_ConstraintType [virtual]
 

Add a new constraint to the light.

Parameters:
in_ConstraintType  Type of constraint to create.
Returns:
CSLConstraint* Pointer to the newly created constraint object.

Reimplemented from CSLConstrainableType.

CSLLightInfo * CSLLight::ConnectLightInfo CSLLightInfo   in_pNewLightInfo
 

Connects an exisiting light info

Parameters:
in_pToConnect  Pointer to the light info to use
Returns:
CSLLightInfo* The added light info or null if there's already one

CSLLightInfo * CSLLight::CreateLightInfo  
 

Creates a new light info

Returns:
CSLLightInfo* The new light info or null if there's already one

SI_Error CSLLight::DestroyLightInfo  
 

Destroys the light info

Returns:
SI_Error Whether or not the light info could be destroyed

CSIBCColorf CSLLight::GetColor  
 

Return the color of the light.

Returns:
CSIBCColorf Light color.

CSIBCVector3D CSLLight::GetPosition  
 

Return the position of the light.

Returns:
CSIBCVector3D Light position.

CSLLightInfo * CSLLight::LightInfo  
 

Gets a pointer to the light info

Returns:
CSLLightInfo* Pointer to the light info

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

Reimplemented in CSLDirectionalLight, and CSLSpotLight.

CSLAnimatableType * CSLLight::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_szParameterName  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 CSLTemplate.

Reimplemented in CSLDirectionalLight, and CSLSpotLight.

SI_Void CSLLight::SetColor CSIBCColorf   in_rColor
 

Change the color of the light.

Parameters:
in_rColor  New light color.
Returns:
SI_Void

SI_Void CSLLight::SetPosition CSIBCVector3D   in_rValue
 

Change the position of the light.

Parameters:
in_rValue  New light position.
Returns:
SI_Void

SI_Error CSLLight::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 CSLConstrainableType.

Reimplemented in CSLDirectionalLight, CSLInfiniteLight, CSLPointLight, and CSLSpotLight.


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.