- Main Page
- Classes
- Files
- Directories

- Class List
- Class Hierarchy
- Class Members

Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Friends

# FbxGlobalSettings Class Reference

This reference page is linked to from the following overview topics: FBX SDK 2014, Supported Scene Elements, FBX Scenes, Lights, List of Python Fbx classes.

Search for all occurrences

## Detailed Description

This class contains functions for accessing global settings.

Definition at line 27 of file fbxglobalsettings.h.

`#include <fbxglobalsettings.h>`

Inheritance diagram for FbxGlobalSettings:
[legend]

List of all members.

## Classes
struct | TimeMarker
## Public Member Functions
void | SetOriginalUpAxis (const FbxAxisSystem &pAxisSystem)
| Sets the coordinate system's original Up Axis when the scene is created.
int | GetOriginalUpAxis () const
| Returns the coordinate system's original Up Axis.
virtual FbxObject & | Copy (const FbxObject &pObject)
| Copy an object content into this object.
## Protected Member Functions
virtual void | Construct (const FbxGlobalSettings *pFrom)
virtual void | ConstructProperties (bool pForceSet)
| Optional property constructor override, automatically called by default constructor.
## Protected Attributes
FbxPropertyT< FbxInt > | UpAxis
FbxPropertyT< FbxInt > | UpAxisSign
FbxPropertyT< FbxInt > | FrontAxis
FbxPropertyT< FbxInt > | FrontAxisSign
FbxPropertyT< FbxInt > | CoordAxis
FbxPropertyT< FbxInt > | CoordAxisSign
FbxPropertyT< FbxInt > | OriginalUpAxis
FbxPropertyT< FbxInt > | OriginalUpAxisSign
FbxPropertyT< FbxDouble > | UnitScaleFactor
FbxPropertyT< FbxDouble > | OriginalUnitScaleFactor
FbxPropertyT< FbxDouble3 > | AmbientColor
FbxPropertyT< FbxString > | DefaultCamera
FbxPropertyT< FbxEnum > | TimeMode
FbxPropertyT< FbxEnum > | TimeProtocol
FbxPropertyT< FbxEnum > | SnapOnFrameMode
FbxPropertyT< FbxTime > | TimeSpanStart
FbxPropertyT< FbxTime > | TimeSpanStop
FbxPropertyT< FbxDouble > | CustomFrameRate
## Friends
class | FbxWriterFbx6
## Axis system
void | SetAxisSystem (const FbxAxisSystem &pAxisSystem)
| Sets the scene's coordinate system.
FbxAxisSystem | GetAxisSystem ()
| Returns the scene's current coordinate system.
## System Units
void | SetSystemUnit (const FbxSystemUnit &pOther)
| Sets the unit of measurement used by the system.
FbxSystemUnit | GetSystemUnit () const
| Returns the unit of measurement used by the system.
void | SetOriginalSystemUnit (const FbxSystemUnit &pOther)
| Sets the original unit of measurement used by the system.
FbxSystemUnit | GetOriginalSystemUnit () const
| Returns the original unit of measurement used by the system.
## Light Settings
void | SetAmbientColor (FbxColor pAmbientColor)
| Sets the ambient color.
FbxColor | GetAmbientColor () const
| Returns the ambient color.
## Camera Settings
bool | SetDefaultCamera (const char *pCameraName)
| Sets the default camera.
FbxString | GetDefaultCamera () const
| Returns the default camera name.
## Time Settings
enum | ESnapOnFrameMode { eNoSnap, eSnapOnFrame, ePlayOnFrame, eSnapAndPlayOnFrame }
| Snap on frame mode. More...
void | SetTimeMode (FbxTime::EMode pTimeMode)
| Sets the time mode.
FbxTime::EMode | GetTimeMode () const
| Returns the time mode.
void | SetTimeProtocol (FbxTime::EProtocol pTimeProtocol)
| Sets the time protocol.
FbxTime::EProtocol | GetTimeProtocol () const
| Returns the time protocol.
void | SetSnapOnFrameMode (ESnapOnFrameMode pSnapOnFrameMode)
| Sets the snap on frame mode.
ESnapOnFrameMode | GetSnapOnFrameMode () const
| Returns the snap on frame mode.
void | SetTimelineDefaultTimeSpan (const FbxTimeSpan &pTimeSpan)
| Sets the default time span of the time line.
void | GetTimelineDefaultTimeSpan (FbxTimeSpan &pTimeSpan) const
| Returns the default time span of the time line.
void | SetCustomFrameRate (double pCustomFrameRate)
| Set custom frame rate.
double | GetCustomFrameRate () const
| Return frame rate if the time mode is FbxTime::eCustom.
## Time Markers
int | GetTimeMarkerCount () const
| Returns the number of time markers.
TimeMarker | GetTimeMarker (int pIndex, FbxStatus *pStatus=NULL) const
| Returns the time marker at the given index.
void | AddTimeMarker (const TimeMarker &pTimeMarker, FbxStatus *pStatus=NULL)
| Adds a time marker.
void | ReplaceTimeMarker (int pIndex, const TimeMarker &pTimeMarker, FbxStatus *pStatus=NULL)
| Replaces the time marker at the specified index with the new one.
void | RemoveAllTimeMarkers ()
| Removes all time markers and sets the current time marker index to -1.
bool | SetCurrentTimeMarker (int pIndex, FbxStatus *pStatus=NULL)
| Sets the index of the current time marker.
int | GetCurrentTimeMarker () const
| Returns the current time marker index.

## Member Enumeration Documentation

enum ESnapOnFrameMode

Search for all occurrences

Snap on frame mode.

Enumerator:

  eNoSnap | Search for all occurrences
  eSnapOnFrame | No snap. Search for all occurrences
  ePlayOnFrame | Snap on frame. Search for all occurrences
  eSnapAndPlayOnFrame | Play on frame. Snap and play on frame. Search for all occurrences

Definition at line 149 of file fbxglobalsettings.h.

        {
            eNoSnap,
            eSnapOnFrame,
            ePlayOnFrame,
            eSnapAndPlayOnFrame
        };

## Member Function Documentation

void SetAxisSystem | ( | const FbxAxisSystem & | pAxisSystem | ) |

Search for all occurrences

Sets the scene's coordinate system.

Parameters:

  pAxisSystem | The coordinate system to set.

FbxAxisSystem GetAxisSystem | ( |  | ) |

Search for all occurrences

Returns the scene's current coordinate system.

Returns:
  The scene's current coordinate system.

void SetOriginalUpAxis | ( | const FbxAxisSystem & | pAxisSystem | ) |

Search for all occurrences

Sets the coordinate system's original Up Axis when the scene is created.

Parameters:

  pAxisSystem | The coordinate system whose Up Axis is copied.

int GetOriginalUpAxis | ( |  | ) | const

Search for all occurrences

Returns the coordinate system's original Up Axis.

Returns:
  The coordinate system's original Up Axis when the scene is created. 0 is X, 1 is Y, 2 is Z axis.

void SetSystemUnit | ( | const FbxSystemUnit & | pOther | ) |

Search for all occurrences

Sets the unit of measurement used by the system.

Parameters:

  pOther | The system unit to set.

FbxSystemUnit GetSystemUnit | ( |  | ) | const

Search for all occurrences

Returns the unit of measurement used by the system.

Returns:
  The unit of measurement used by the system.

void SetOriginalSystemUnit | ( | const FbxSystemUnit & | pOther | ) |

Search for all occurrences

Sets the original unit of measurement used by the system.

Parameters:

  pOther | The original system unit to set.

FbxSystemUnit GetOriginalSystemUnit | ( |  | ) | const

Search for all occurrences

Returns the original unit of measurement used by the system.

Returns:
  The original unit of measurement used by the system.

void SetAmbientColor | ( | FbxColor | pAmbientColor | ) |

Search for all occurrences

Sets the ambient color.

Parameters:

  pAmbientColor | The ambient color to set.

Remarks:
  The ambient color only uses the RGB channels.

FbxColor GetAmbientColor | ( |  | ) | const

Search for all occurrences

Returns the ambient color.

Returns:
  The ambient color.

bool SetDefaultCamera | ( | const char * | pCameraName | ) |

Search for all occurrences

Sets the default camera.

Parameters:

  pCameraName | Name of the default camera.

Returns:
  `true` if camera name is valid, returns `false` if the camera does not have a valid name.

Remarks:
  A valid camera name can be either one of the defined tokens (FBXSDK_CAMERA_PERSPECTIVE, FBXSDK_CAMERA_TOP, FBXSDK_CAMERA_FRONT, FBXSDK_CAMERA_BACK, FBXSDK_CAMERA_RIGHT, FBXSDK_CAMERA_LEFT and FBXSDK_CAMERA_BOTTOM) or the name of a camera inserted in the node tree under the scene's root node.

FbxString GetDefaultCamera | ( |  | ) | const

Search for all occurrences

Returns the default camera name.

Returns:
  The default camera name, or an empty string if no camera name has been set.

void SetTimeMode | ( | FbxTime::EMode | pTimeMode | ) |

Search for all occurrences

Sets the time mode.

Parameters:

  pTimeMode | One of the defined modes in class FbxTime.

FbxTime::EMode GetTimeMode | ( |  | ) | const

Search for all occurrences

Returns the time mode.

Returns:
  The currently set TimeMode.

void SetTimeProtocol | ( | FbxTime::EProtocol | pTimeProtocol | ) |

Search for all occurrences

Sets the time protocol.

Parameters:

  pTimeProtocol | One of the defined protocols in FbxTime class.

FbxTime::EProtocol GetTimeProtocol | ( |  | ) | const

Search for all occurrences

Returns the time protocol.

Returns:
  The currently set time protocol (default FbxTime::eFrameCount).

void SetSnapOnFrameMode | ( | ESnapOnFrameMode | pSnapOnFrameMode | ) |

Search for all occurrences

Sets the snap on frame mode.

Parameters:

  pSnapOnFrameMode | One of the following values: eNoSnap, eSnapOnFrame, ePlayOnFrame, or eSnapAndPlayOnFrame.

ESnapOnFrameMode GetSnapOnFrameMode | ( |  | ) | const

Search for all occurrences

Returns the snap on frame mode.

Returns:
  The currently set snap on frame mode (default eNoSnap).

void SetTimelineDefaultTimeSpan | ( | const FbxTimeSpan & | pTimeSpan | ) |

Search for all occurrences

Sets the default time span of the time line.

Parameters:

  pTimeSpan | The default time span of the time line.

void GetTimelineDefaultTimeSpan | ( | FbxTimeSpan & | pTimeSpan | ) | const

Search for all occurrences

Returns the default time span of the time line.

Parameters:

  pTimeSpan | The default time span of the time line.

void SetCustomFrameRate | ( | double | pCustomFrameRate | ) |

Search for all occurrences

Set custom frame rate.

This is meaningless if the time mode is not FbxTime::eCustom.

double GetCustomFrameRate | ( |  | ) | const

Search for all occurrences

Return frame rate if the time mode is FbxTime::eCustom.

If the time mode is not FbxTime::eCustom, return -1.

int GetTimeMarkerCount | ( |  | ) | const

Search for all occurrences

Returns the number of time markers.

Returns:
  The number of time markers.

TimeMarker GetTimeMarker | ( | int | pIndex,
|  | FbxStatus * | pStatus = `NULL`
| ) |  | const

Search for all occurrences

Returns the time marker at the given index.

Parameters:

  pIndex | The time marker index.
  pStatus | The FbxStatus object to hold error codes.

Returns:
  A copy of the time marker at the given index, or an empty one if an error occurred.

void AddTimeMarker | ( | const TimeMarker & | pTimeMarker,
|  | FbxStatus * | pStatus = `NULL`
| ) |  |

Search for all occurrences

Adds a time marker.

Parameters:

  pTimeMarker | The new time marker to be added.
  pStatus | The FbxStatus object to hold error codes.

void ReplaceTimeMarker | ( | int | pIndex,
|  | const TimeMarker & | pTimeMarker,
|  | FbxStatus * | pStatus = `NULL`
| ) |  |

Search for all occurrences

Replaces the time marker at the specified index with the new one.

Parameters:

  pIndex | The time marker index.
  pTimeMarker | The new time marker.
  pStatus | The FbxStatus object to hold error codes.

void RemoveAllTimeMarkers | ( |  | ) |

Search for all occurrences

Removes all time markers and sets the current time marker index to -1.

bool SetCurrentTimeMarker | ( | int | pIndex,
|  | FbxStatus * | pStatus = `NULL`
| ) |  |

Search for all occurrences

Sets the index of the current time marker.

Parameters:

  pIndex | The current time marker index.
  pStatus | The FbxStatus object to hold error codes.

Returns:
  `true` if successful, or returns `false` if the index is not valid.

int GetCurrentTimeMarker | ( |  | ) | const

Search for all occurrences

Returns the current time marker index.

Returns:
  The current time marker index, or -1 if no current time marker has been set.

virtual FbxObject& Copy | ( | const FbxObject & | pObject | ) | `[virtual]`

Search for all occurrences

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 Construct | ( | const FbxGlobalSettings * | pFrom | ) | `[protected, virtual]`

Search for all occurrences

virtual void ConstructProperties | ( | bool | pForceSet | ) | `[protected, virtual]`

Search for all occurrences

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 FbxObject.

## Friends And Related Function Documentation

friend class FbxWriterFbx6`[friend]`

Search for all occurrences

Definition at line 302 of file fbxglobalsettings.h.

## Member Data Documentation

FbxPropertyT<FbxInt> UpAxis`[protected]`

Search for all occurrences

Definition at line 265 of file fbxglobalsettings.h.

FbxPropertyT<FbxInt> UpAxisSign`[protected]`

Search for all occurrences

Definition at line 266 of file fbxglobalsettings.h.

FbxPropertyT<FbxInt> FrontAxis`[protected]`

Search for all occurrences

Definition at line 268 of file fbxglobalsettings.h.

FbxPropertyT<FbxInt> FrontAxisSign`[protected]`

Search for all occurrences

Definition at line 269 of file fbxglobalsettings.h.

FbxPropertyT<FbxInt> CoordAxis`[protected]`

Search for all occurrences

Definition at line 271 of file fbxglobalsettings.h.

FbxPropertyT<FbxInt> CoordAxisSign`[protected]`

Search for all occurrences

Definition at line 272 of file fbxglobalsettings.h.

FbxPropertyT<FbxInt> OriginalUpAxis`[protected]`

Search for all occurrences

Definition at line 274 of file fbxglobalsettings.h.

FbxPropertyT<FbxInt> OriginalUpAxisSign`[protected]`

Search for all occurrences

Definition at line 275 of file fbxglobalsettings.h.

FbxPropertyT<FbxDouble> UnitScaleFactor`[protected]`

Search for all occurrences

Definition at line 277 of file fbxglobalsettings.h.

FbxPropertyT<FbxDouble> OriginalUnitScaleFactor`[protected]`

Search for all occurrences

Definition at line 278 of file fbxglobalsettings.h.

FbxPropertyT<FbxDouble3> AmbientColor`[protected]`

Search for all occurrences

Definition at line 280 of file fbxglobalsettings.h.

FbxPropertyT<FbxString> DefaultCamera`[protected]`

Search for all occurrences

Definition at line 281 of file fbxglobalsettings.h.

FbxPropertyT<FbxEnum> TimeMode`[protected]`

Search for all occurrences

Definition at line 282 of file fbxglobalsettings.h.

FbxPropertyT<FbxEnum> TimeProtocol`[protected]`

Search for all occurrences

Definition at line 283 of file fbxglobalsettings.h.

FbxPropertyT<FbxEnum> SnapOnFrameMode`[protected]`

Search for all occurrences

Definition at line 284 of file fbxglobalsettings.h.

FbxPropertyT<FbxTime> TimeSpanStart`[protected]`

Search for all occurrences

Definition at line 285 of file fbxglobalsettings.h.

FbxPropertyT<FbxTime> TimeSpanStop`[protected]`

Search for all occurrences

Definition at line 286 of file fbxglobalsettings.h.

FbxPropertyT<FbxDouble> CustomFrameRate`[protected]`

Search for all occurrences

Definition at line 287 of file fbxglobalsettings.h.

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

- fbxsdk/fileio/fbxglobalsettings.h

FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings
FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings FbxGlobalSettings