CSLXSICamera Class Reference

This class represents an XSI_Camera template. More...

#include <XSICamera.h>

Inheritance diagram for CSLXSICamera:

CSLPrimitive CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLXSICamera (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLXSICamera ()
SI_Int  GetStandard ()
SI_Void  SetStandard (SI_Int in_lValue)
SI_Float  GetPictureRatio ()
SI_Void  SetPictureRatio (SI_Float in_lValue)
SI_Float  GetFieldOfView ()
SI_Void  SetFieldOfView (SI_Float in_lValue)
SI_Int  GetFieldOfViewType ()
SI_Void  SetFieldOfViewType (SI_Int in_lValue)
SI_Int  GetProjectionType ()
SI_Void  SetProjectionType (SI_Int in_lValue)
SI_Float  GetOrthoHeight ()
SI_Void  SetOrthoHeight (SI_Float in_lValue)
SI_Float  GetInterestDistance ()
SI_Void  SetInterestDistance (SI_Float in_lValue)
SI_Float  GetNearPlane ()
SI_Void  SetNearPlane (SI_Float in_lValue)
SI_Float  GetFarPlane ()
SI_Void  SetFarPlane (SI_Float in_lValue)
SI_Bool  GetProjectionPlaneEnable ()
SI_Void  SetProjectionPlaneEnable (SI_Bool in_lValue)
SI_Float  GetProjPlaneWidth ()
SI_Void  SetProjPlaneWidth (SI_Float in_lValue)
SI_Float  GetProjPlaneHeight ()
SI_Void  SetProjPlaneHeight (SI_Float in_lValue)
SI_Float  GetProjPlaneOffsetX ()
SI_Void  SetProjPlaneOffsetX (SI_Float in_lValue)
SI_Float  GetProjPlaneOffsetY ()
SI_Void  SetProjPlaneOffsetY (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

This class represents an XSI_Camera template.

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

Constructor & Destructor Documentation

CSLXSICamera ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate  
)

Constructor

Parameters:
[in]  in_pScene  Pointer to the scene containing the Camera
[in]  in_pModel  Pointer to the model containing the Camera
[in]  in_pTemplate  Pointer to the CdotXSITemplate containing the Camera
Returns:
an instance of CSLCamera

virtual ~CSLXSICamera (  )  [virtual]

Destructor

Member Function Documentation

SI_Int GetStandard (  ) 

Returns the camera field of view dominance.

Returns:
the camera field of view dominance.

SI_Void SetStandard ( SI_Int  in_lValue  ) 

Changes the camera field of view dominance.

Parameters:
[in]  in_lValue  New camera field of view dominance.

SI_Float GetPictureRatio (  ) 

Returns the camera picture ratio.

Returns:
the camera picture ratio.

SI_Void SetPictureRatio ( SI_Float  in_lValue  ) 

Changes the camera picture ratio.

Parameters:
[in]  in_lValue  New camera picture ratio.

SI_Float GetFieldOfView (  ) 

Returns the camera field of view.

Returns:
the camera field of view.

SI_Void SetFieldOfView ( SI_Float  in_lValue  ) 

Changes the camera field of view.

Parameters:
[in]  in_lValue  New camera field of view.

SI_Int GetFieldOfViewType (  ) 

Returns the camera field of view dominance.

Returns:
the camera field of view dominance.

SI_Void SetFieldOfViewType ( SI_Int  in_lValue  ) 

Changes the camera field of view dominance.

Parameters:
[in]  in_lValue  New camera field of view dominance.

SI_Int GetProjectionType (  ) 

Returns the camera projection type.

Returns:
the camera projection type.

SI_Void SetProjectionType ( SI_Int  in_lValue  ) 

Changes the camera projection type.

Parameters:
[in]  in_lValue  New camera projection type.

SI_Float GetOrthoHeight (  ) 

Returns the camera orthographic height.

Returns:
the camera orthographic height.

SI_Void SetOrthoHeight ( SI_Float  in_lValue  ) 

Changes the camera orthographic height.

Parameters:
[in]  in_lValue  New camera orthographic height.

SI_Float GetInterestDistance (  ) 

Returns the camera interest distance.

Returns:
the camera interest distance.

SI_Void SetInterestDistance ( SI_Float  in_lValue  ) 

Changes the camera interest distance.

Parameters:
[in]  in_lValue  New camera interest distance.

SI_Float GetNearPlane (  ) 

Returns the camera near clipping plane.

Returns:
the camera near clipping plane.

SI_Void SetNearPlane ( SI_Float  in_lValue  ) 

Changes the camera near clipping plane.

Parameters:
[in]  in_lValue  New camera near clipping plane.

SI_Float GetFarPlane (  ) 

Returns the camera far clipping plane.

Returns:
the camera far clipping plane.

SI_Void SetFarPlane ( SI_Float  in_lValue  ) 

Changes the camera far clipping plane.

Parameters:
[in]  in_lValue  New camera far clipping plane.

SI_Bool GetProjectionPlaneEnable (  ) 

Returns the camera projection plane.

Returns:
the camera projection plane.

SI_Void SetProjectionPlaneEnable ( SI_Bool  in_lValue  ) 

Changes the camera projection plane.

Parameters:
[in]  in_lValue  New camera projection plane.

SI_Float GetProjPlaneWidth (  ) 

Returns the camera projection plane width.

Returns:
the camera projection plane width.

SI_Void SetProjPlaneWidth ( SI_Float  in_lValue  ) 

Changes the camera projection plane width.

Parameters:
[in]  in_lValue  New camera projection plane width.

SI_Float GetProjPlaneHeight (  ) 

Returns the camera projection plane height.

Returns:
the camera projection plane height.

SI_Void SetProjPlaneHeight ( SI_Float  in_lValue  ) 

Changes the camera projection plane height.

Parameters:
[in]  in_lValue  New camera projection plane height.

SI_Float GetProjPlaneOffsetX (  ) 

Return the camera projection plane offset X.

Returns:
the camera projection plane offset X.

SI_Void SetProjPlaneOffsetX ( SI_Float  in_lValue  ) 

Changes the camera projection plane offset X.

Parameters:
[in]  in_lValue  New camera projection plane offset X.

SI_Float GetProjPlaneOffsetY (  ) 

Returns the camera projection plane offset Y.

Returns:
the camera projection plane offset Y.

SI_Void SetProjPlaneOffsetY ( SI_Float  in_lValue  ) 

Changes the camera projection plane offset Y.

Parameters:
[in]  in_lValue  New camera projection plane offset Y.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::XSI_CAMERA  The type of this template

Implements CSLTemplate.

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this Camera instance with its IO layer representation

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

Reimplemented from CSLTemplate.

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

Returns a handle on one of this Camera's parameters by using its name

Parameters:
[in]  in_szName  the name of the parameter to get the handle from
Returns:
the handle to the parameter

Reimplemented from CSLTemplate.

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

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

Parameters:
[in]  in_Type  the type of the parameter to get the handle from
[in]  in_szName  the name of the parameter to get the handle from (in case type is not found)
Returns:
the handle to the parameter

Reimplemented from CSLTemplate.

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

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

Parameters:
[in]  in_pParameter  The sub parameter
Returns:
Name of the sub parameter.

Reimplemented from CSLTemplate.

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