CSLXSICameraFocalLength Class Reference

#include <XSICameraFocalLength.h>

Inheritance diagram for CSLXSICameraFocalLength:

CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLXSICameraFocalLength (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLXSICameraFocalLength ()
SI_Float  GetFocalLength ()
SI_Void  SetFocalLength (SI_Float in_lValue)
virtual ETemplateType  Type ()
virtual SI_Error  Synchronize ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType *  ParameterFromType (EFCurveType in_Type, SI_Char *in_szName)
virtual const SI_Char *  GetParameterName (CSLAnimatableType *in_pParameter)

Detailed Description

Base class to handle camera focal length functionality for dotXSI 5.0+ (see the XSI_CameraFocalLength template reference).

Constructor & Destructor Documentation

CSLXSICameraFocalLength ( 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
Returns:
an instance of CSLCamera

virtual ~CSLXSICameraFocalLength (  )  [virtual]

Destructor

Member Function Documentation

SI_Float GetFocalLength (  ) 

Return the camera projection plane distance.

Returns:
SI_Float the camera projection plane distance.

SI_Void SetFocalLength ( SI_Float  in_lValue  ) 

Change the camera projection plane distance.

Parameters:
SI_Float  New camera projection plane distance.
Returns:
SI_Void

virtual ETemplateType Type (  )  [inline, virtual]

Returns the type of this template (XSI_CAMERA_FOCALLENGTH)

Returns:
CSLTemplate::ETemplateType The type of this template (XSI_CAMERA_FOCALLENGTH)

Implements CSLTemplate.

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this Camera instance with its IO layer representation

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

Reimplemented from CSLTemplate.

virtual CSLAnimatableType* ParameterFromName ( SI_Char *  in_szName  )  [virtual]

Gets a handle on one of this Camera'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.

virtual CSLAnimatableType* ParameterFromType ( EFCurveType  in_Type,
SI_Char *  in_szName  
) [virtual]

Gets a handle on one of this Camera's parameters by using its type

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

Reimplemented from CSLTemplate.

virtual const SI_Char* GetParameterName ( CSLAnimatableType *  in_pParameter  )  [virtual]

Return the name (string) of a specified sub parameter.

Parameters:
in_pParameter  The sub parameter
Returns:
SI_Char* Name of the sub parameter.

Reimplemented from CSLTemplate.

The documentation for this class was generated from the following file: