# CSLXSICamera Class Reference

`#include <XSICamera.h>`

Inheritance diagram for CSLXSICamera:

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

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_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 ~CSLXSICamera | ( |  | ) | `[virtual]`

Destructor

## Member Function Documentation

SI_Int GetStandard | ( |  | ) |

Return the camera field of view dominance.

Returns:
  SI_Int the camera field of view dominance.

SI_Void SetStandard | ( | SI_Int | in_lValue | ) |

Change the camera field of view dominance.

Parameters:

  | SI_Int | New camera field of view dominance.

Returns:
  SI_Void

SI_Float GetPictureRatio | ( |  | ) |

Return the camera picture ratio.

Returns:
  SI_Float the camera picture ratio.

SI_Void SetPictureRatio | ( | SI_Float | in_lValue | ) |

Change the camera picture ratio.

Parameters:

  | SI_Float | New camera picture ratio.

Returns:
  SI_Void

SI_Float GetFieldOfView | ( |  | ) |

Return the camera field of view.

Returns:
  SI_Float the camera field of view.

SI_Void SetFieldOfView | ( | SI_Float | in_lValue | ) |

Change the camera field of view.

Parameters:

  | SI_Float | New camera field of view.

Returns:
  SI_Void

SI_Int GetFieldOfViewType | ( |  | ) |

Return the camera field of view dominance.

Returns:
  SI_Int the camera field of view dominance.

SI_Void SetFieldOfViewType | ( | SI_Int | in_lValue | ) |

Change the camera field of view dominance.

Parameters:

  | SI_Int | New camera field of view dominance.

Returns:
  SI_Void

SI_Int GetProjectionType | ( |  | ) |

Return the camera projection type.

Returns:
  SI_Int the camera projection type.

SI_Void SetProjectionType | ( | SI_Int | in_lValue | ) |

Change the camera projection type.

Parameters:

  | SI_Int | New camera projection type.

Returns:
  SI_Void

SI_Float GetOrthoHeight | ( |  | ) |

Return the camera orthographic height.

Returns:
  SI_Float the camera orthographic height.

SI_Void SetOrthoHeight | ( | SI_Float | in_lValue | ) |

Change the camera orthographic height.

Parameters:

  | SI_Float | New camera orthographic height.

Returns:
  SI_Void

SI_Float GetInterestDistance | ( |  | ) |

Return the camera interest distance.

Returns:
  SI_Float the camera interest distance.

SI_Void SetInterestDistance | ( | SI_Float | in_lValue | ) |

Change the camera interest distance.

Parameters:

  | SI_Float | New camera interest distance.

Returns:
  SI_Void

SI_Float GetNearPlane | ( |  | ) |

Return the camera near clipping plane.

Returns:
  SI_Float the camera near clipping plane.

SI_Void SetNearPlane | ( | SI_Float | in_lValue | ) |

Change the camera near clipping plane.

Parameters:

  | SI_Float | New camera near clipping plane.

Returns:
  SI_Void

SI_Float GetFarPlane | ( |  | ) |

Return the camera far clipping plane.

Returns:
  SI_Float the camera far clipping plane.

SI_Void SetFarPlane | ( | SI_Float | in_lValue | ) |

Change the camera far clipping plane.

Parameters:

  | SI_Float | New camera far clipping plane.

Returns:
  SI_Void

SI_Bool GetProjectionPlaneEnable | ( |  | ) |

Return the camera projection plane.

Returns:
  SI_Bool the camera projection plane.

SI_Void SetProjectionPlaneEnable | ( | SI_Bool | in_lValue | ) |

Change the camera projection plane.

Parameters:

  | SI_Int | New camera projection plane.

Returns:
  SI_Void

SI_Float GetProjPlaneWidth | ( |  | ) |

Return the camera projection plane width.

Returns:
  SI_Float the camera projection plane width.

SI_Void SetProjPlaneWidth | ( | SI_Float | in_lValue | ) |

Change the camera projection plane width.

Parameters:

  | SI_Float | New camera projection plane width.

Returns:
  SI_Void

SI_Float GetProjPlaneHeight | ( |  | ) |

Return the camera projection plane height.

Returns:
  SI_Float the camera projection plane height.

SI_Void SetProjPlaneHeight | ( | SI_Float | in_lValue | ) |

Change the camera projection plane height.

Parameters:

  | SI_Float | New camera projection plane height.

Returns:
  SI_Void

SI_Float GetProjPlaneOffsetX | ( |  | ) |

Return the camera projection plane offset X.

Returns:
  SI_Float the camera projection plane offset X.

SI_Void SetProjPlaneOffsetX | ( | SI_Float | in_lValue | ) |

Change the camera projection plane offset X.

Parameters:

  | SI_Float | New camera projection plane offset X.

Returns:
  SI_Void

SI_Float GetProjPlaneOffsetY | ( |  | ) |

Return the camera projection plane offset Y.

Returns:
  SI_Float the camera projection plane offset Y.

SI_Void SetProjPlaneOffsetY | ( | SI_Float | in_lValue | ) |

Change the camera projection plane offset Y.

Parameters:

  | SI_Float | New camera projection plane offset Y.

Returns:
  SI_Void

virtual ETemplateType Type | ( |  | ) | `[inline, virtual]`

Returns the type of this template (XSI_CAMERA)

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

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:

- XSICamera.h