This reference page is linked to from the following overview topics: FBX Node Attributes, List of Python Fbx classes.
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:
- FbxCamera and FbxCameraStereo.
Definition at line 32 of file fbxcameraswitcher.h.
#include <fbxcameraswitcher.h>
Public Member Functions | |
| virtual FbxNodeAttribute::EType | GetAttributeType () const |
| Return the type of node attribute which is EType::eCameraSwitcher. | |
| virtual FbxObject & | Copy (const FbxObject &pObject) |
| Copy an object content into this object. | |
| void | AddCameraName (char *pCameraName) |
| char * | GetCameraName (FbxUInt pIndex) const |
| FbxUInt | GetCameraNameCount () const |
| void | ClearCameraNames () |
Protected Member Functions | |
| virtual void | Destruct (bool pRecursive) |
| Optional destructor override, automatically called by default destructor. | |
| virtual void | ConstructProperties (bool pForceSet) |
| Optional property constructor override, automatically called by default constructor. | |
Protected Attributes | |
| FbxArray< FbxString * > | mCameraNameList |
Properties | |
| FbxPropertyT< FbxInt > | 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. | |
Member Function Documentation
| virtual FbxNodeAttribute::EType GetAttributeType | ( | ) | const [virtual] |
Return the type of node attribute which is EType::eCameraSwitcher.
Reimplemented from FbxNodeAttribute.
| 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 The index 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.
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 FbxObject.
| virtual void Destruct | ( | bool | pRecursive | ) | [protected, virtual] |
Optional destructor override, automatically called by default destructor.
- Parameters:
-
pRecursive If true, children objects should be destroyed as well.
- Remarks:
- In case it is decided to override this function, do not forget to call ParentClass::Destruct(pResursive) at the end.
Reimplemented from FbxObject.
| virtual void ConstructProperties | ( | bool | pForceSet | ) | [protected, virtual] |
Optional property constructor override, automatically called by default constructor.
- Parameters:
-
pForceSet If the property value must be set regardless of default value.
- Remarks:
- If your object have properties, they must be initialized in this function.
Reimplemented from FbxNodeAttribute.
| void AddCameraName | ( | char * | pCameraName | ) |
| char* GetCameraName | ( | FbxUInt | pIndex | ) | const |
| FbxUInt GetCameraNameCount | ( | ) | const |
| void ClearCameraNames | ( | ) |
Member Data Documentation
This property handles the index of camera.
Default value is 1.
Definition at line 45 of file fbxcameraswitcher.h.
FbxArray<FbxString*> mCameraNameList [protected] |
Definition at line 95 of file fbxcameraswitcher.h.
The documentation for this class was generated from the following file:
- fbxsdk/scene/geometry/fbxcameraswitcher.h
