Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLDirectionalLight Class Reference

Describes a point light. More...

#include <DirectionalLight.h>

Inheritance diagram for CSLDirectionalLight::

CSLLight CSLPrimitive CSLConstrainableType CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

Describes a point light.


Constructor & Destructor Documentation

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

Constructor

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

CSLDirectionalLight::~CSLDirectionalLight   [virtual]
 

Destructor


Member Function Documentation

CSIBCVector3D CSLDirectionalLight::GetDirection  
 

Return the direction of the light.

Returns:
CSIBCVector3D Light direction.

CSLAnimatableType * CSLDirectionalLight::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 * CSLDirectionalLight::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 CSLDirectionalLight::SetDirection CSIBCVector3D   in_rValue
 

Change the direction of the light.

Parameters:
in_rValue  New light direction.
Returns:
SI_Void

SI_Error CSLDirectionalLight::Synchronize   [virtual]
 

Synchronizes this directional 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 CSLDirectionalLight::Type   [virtual]
 

Get the template type

Returns:
ETemplateType the template type of the directional light

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.