Public Member Functions | Protected Member Functions | Protected Attributes

KFbxCameraSwitcher Class Reference

This reference page is linked to from the following overview topics: FBX Node Attributes, List of Python FBX classes.


Search for all occurrences

Detailed Description

This node attribute contains methods for accessing the properties of a camera switcher.

The camera switcher is a concept of Motion Builder. The camera switcher lets you switch between the custom cameras placed in your scene so you can create an animation using multiple camera angles. Custom cameras are cameras which created by users, while the default cameras are top, bottom, left, right, front, back and perspective camera. The Camera switcher contains the custom cameras you have created. If you have no custom cameras created in your scene, the Camera switcher is empty. Please read Motion Builder documentation for more details.

See also:
KFbxCamera KFbxCameraStereo
Examples:

ViewScene/SetCamera.cxx.

Definition at line 60 of file kfbxcameraswitcher.h.

#include <kfbxcameraswitcher.h>

Inheritance diagram for KFbxCameraSwitcher:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual EAttributeType  GetAttributeType () const
  Return the type of node attribute which is EAttributeType::eCAMERA_SWITCHER.
virtual KFbxObject Copy (const KFbxObject &pObject)
  Copy an object content into this object.
void  AddCameraName (char *pCameraName)
char *  GetCameraName (kUInt pIndex) const
kUInt  GetCameraNameCount () const
void  ClearCameraNames ()

Protected Member Functions

  KFbxCameraSwitcher (KFbxSdkManager &pManager, char const *pName)
virtual void  Destruct (bool pRecursive, bool pDependents)
virtual bool  ConstructProperties (bool pForceSet)

Protected Attributes

KArrayTemplate< KString * >  mCameraNameList

Properties

KFbxPropertyInteger1  CameraIndex
  This property handles the index of camera.

Default Animation Values

These functions provides direct access to default animation values specific to a camera switcher.The default animation values are found in the default take node of the associated node. These functions only work if the camera switcher has been associated with a node.Camera indices start at 1. Out of range indices are clamped between 1 and the number of cameras in the scene. The index of a camera refers to its order of appearance when searching the node tree depth first.
int  GetDefaultCameraIndex () const
  Get default camera index.
void  SetDefaultCameraIndex (int pIndex)
  Set default camera index.

Constructor & Destructor Documentation

KFbxCameraSwitcher ( KFbxSdkManager pManager,
char const *  pName 
) [protected]

Member Function Documentation

virtual EAttributeType GetAttributeType ( ) const [virtual]

Return the type of node attribute which is EAttributeType::eCAMERA_SWITCHER.

Reimplemented from KFbxNodeAttribute.

int GetDefaultCameraIndex ( ) const

Get default camera index.

Returns:
Camera index. The return value is an integer between 1 and the number of cameras in the scene, or 0 if there are no default camera set in the camera switcher.
void SetDefaultCameraIndex ( int  pIndex )

Set default camera index.

Parameters:
pIndex Id of the camera to set as default. This parameter has an integer scale from 1 to the number of cameras in the scene. Its default value is 1 if there is at least one camera in the camera switcher, 0 if there are none. No validation checks are made.
virtual KFbxObject& Copy ( const KFbxObject pObject ) [virtual]

Copy an object content into this object.

Parameters:
pObject The source object to copy data from.
Returns:
Returns the destination object being modified by the source.
Remarks:
This function replace the assignment operator (operator=). It will copy all property values and the name. Connections are NOT copied.

Reimplemented from KFbxObject.

virtual void Destruct ( bool  pRecursive,
bool  pDependents 
) [protected, virtual]
virtual bool ConstructProperties ( bool  pForceSet ) [protected, virtual]
void AddCameraName ( char *  pCameraName )
char* GetCameraName ( kUInt  pIndex ) const
kUInt GetCameraNameCount ( ) const
void ClearCameraNames ( )

Member Data Documentation

This property handles the index of camera.

Default value is 1.

Examples:
ViewScene/SetCamera.cxx.

Definition at line 73 of file kfbxcameraswitcher.h.


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

KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher
KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher KFbxCameraSwitcher