Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLCamera Class Reference

Class describing a camera and its interest. More...

#include <Camera.h>

Inheritance diagram for CSLCamera::

CSLPrimitive CSLConstrainableType CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

Class describing a camera and its interest.

Describes a camera and its interest.


Constructor & Destructor Documentation

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

Constructor

Parameters:
in_pScene  Pointer to the scene containing the Camera
in_pModel  Pointer to the model containing the Camera
in_pTemplate  Pointer to the CdotXSITemplate containing the Camera

CSLCamera::~CSLCamera   [virtual]
 

Destructor


Member Function Documentation

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

Add a new constraint to the camera.

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

Reimplemented from CSLConstrainableType.

SI_Float CSLCamera::GetFarPlane  
 

Return the far plane of the camera.

Returns:
SI_Float Far plane.

SI_Float CSLCamera::GetFieldOfView  
 

Return the field of view of the camera.

Returns:
SI_Float Field of view.

CSIBCVector3D CSLCamera::GetInterestPosition  
 

Return the position of the camera's interest.

Returns:
CSIBCVector3D Interest position.

SI_Float CSLCamera::GetNearPlane  
 

Return the near plane of the camera.

Returns:
SI_Float Near plane value.

CSIBCVector3D CSLCamera::GetPosition  
 

Return the position of the camera.

Returns:
CSIBCVector3D Position.

SI_Float CSLCamera::GetRoll  
 

Return the roll of the camera.

Returns:
SI_Float Roll.

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

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

Returns an AnimatableParameter from a EFCurveType.

Parameters:
EFCurveType  FCurve Type
SI_Char  * The name of the parameter if this FCurve this is unknown.
Returns:
SI_Error Error code.
Note:
The Camera supports the following FCurve types:
  • SI_POSITION_X
  • SI_POSITION_Y
  • SI_POSITION_Z
  • SI_INTEREST_X
  • SI_INTEREST_Y
  • SI_INTEREST_Z
  • SI_ROLL
  • SI_FOV
  • SI_NEAR
  • SI_FAR
Example - Adding FCurves on a Camera

                CSLFCurve* l_pFCurveX = l_pCamera->CreateFCurve( CSLTemplate::SI_POSITION_X, CSLTemplate::SI_CUBIC );
                CSLFCurve* l_pFCurveY = l_pCamera->CreateFCurve( CSLTemplate::SI_POSITION_Y, CSLTemplate::SI_CUBIC );
                CSLFCurve* l_pFCurveZ = l_pCamera->CreateFCurve( CSLTemplate::SI_POSITION_Z, CSLTemplate::SI_CUBIC );

                CSLFCurve* l_pFCurveRoll = l_pCamera->CreateFCurve( CSLTemplate::SI_ROLL, CSLTemplate::SI_CUBIC );

                
                // Add the keys etc...

Reimplemented from CSLTemplate.

SI_Void CSLCamera::SetFarPlane SI_Float    in_fValue
 

Change the far plane of the camera.

Parameters:
SI_Float  New far plane. value

SI_Void CSLCamera::SetFieldOfView SI_Float    in_fValue
 

Change the field of view of the camera.

Parameters:
SI_Float  New field of view value.

SI_Void CSLCamera::SetInterestPosition CSIBCVector3D   in_rValue
 

Change the position of the camera's interest.

Parameters:
CSIBCVector3D&  New interest position.

SI_Void CSLCamera::SetNearPlane SI_Float    in_fValue
 

Change the near plane of the camera.

Parameters:
SI_Float  New near plane value.

SI_Void CSLCamera::SetPosition CSIBCVector3D   in_rValue
 

Change the position of the camera.

Parameters:
CSIBCVector3D&  New position.

SI_Void CSLCamera::SetRoll SI_Float    in_fValue
 

Change the roll of the camera.

Parameters:
SI_Float  New roll value.

CSLTemplate::ETemplateType CSLCamera::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.