FBFbxOptions Class Reference
 
 
 
FBFbxOptions Class Reference

#include <fbfbxoptions.h>


Class Description

Customize file loading and saving.

Definition at line 116 of file fbfbxoptions.h.

Inheritance diagram for FBFbxOptions:
FBComponent FBPlug FBWrapperHolder

Public Member Functions

  FBFbxOptions (bool pLoad, const char *pFilePathToLoad=NULL, HIObject pObject=NULL)
  Constructor.
void  SetAll (FBElementAction pElementAction, bool pAnimation)
  Set All Options.
void  SaveToString (FBString &pString, FBOptionsContext context)
  Serialize all options to a string Serialize all options to a string specifying a context.
void  SetFromString (const char *pString, FBOptionsContext context)
  Set all options from string Set all parameters from a formatted string (previously serialized with SaveToString)
void  SetNamespaceList (const FBStringList &pNamespaceList)
  SetNamespaceList upon save or load.
FBStringList  GetNamespaceList ()
  GetNamespaceList upon save or load.
virtual bool  FBCreate ()
  Open Reality Creation function.
virtual void  FBDestroy ()
  Open Reality destruction function.
virtual void  FBDelete () override
  Open Reality deletion function.
virtual bool  SetHIObject (HIObject pObject, bool pSDKComponent) override
  Assign component to an internal pointer.
virtual int  PropertyAdd (FBProperty *pProperty)
  Add a property to the component's property manager.
bool  PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
  Add a reference property to the component's property manager.
void  PropertyRemove (FBProperty *pProperty)
  Remove a Property from the component's Property manager.
void  PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
  Get list of properties which have been modified since last loading.
FBProperty PropertyCreate (const char *pName, FBPropertyType pType, const char *pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
  Create user or dynamic property.
FBObjectFlag  GetObjectFlags ()
  Get all Object Flags (concatenated).
void  SetObjectFlags (FBObjectFlag pFlags)
  SetObjectFlags.
bool  HasObjectFlags (FBObjectFlag pFlags)
  Check whether a specific object flag is enabled.
void  EnableObjectFlags (FBObjectFlag pFlags)
  Enable a specific Object Flags.
void  DisableObjectFlags (FBObjectFlag pFlags)
  Disable a specific Object Flags.
void  SetObjectStatus (FBObjectStatus pStatus, bool pValue)
  Enable/Disable a specific Object Status.
bool  GetObjectStatus (FBObjectStatus pStatus)
  Check to see if an object status is enabled.
bool  ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
  ProcessNamespaceHierarchy.
bool  ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
  ProcessObjectNamespace.
virtual const char *  ClassName () override
  Get the class name.
virtual bool  UseCustomPropertyViewSet () const
  Use the custom property viewSet or not.
const char *  GetFullName (void)
  Get the full name.
void  SetOwnerNamespace (FBNamespace *pOwnerNSObj)
  Set the owner Namespace object.
FBNamespace GetOwnerNamespace (void)
  Get the owner Namespace object.
FBFileReference GetOwnerFileReference (void)
  Get the owner FileReference object.
void  HardSelect ()
  HardSelect.
  IObject_Declare (K_IMPLEMENTATION)
  ICallback_Declare (K_IMPLEMENTATION)
virtual bool  Is (int pTypeId)
  Returns true if object is of type TypeId.
virtual int  GetTypeId ()
  GetTypeId( int pTypeId )
void  KObjectEvent (HIRegister pView, HKEventBase pEvent)
virtual HIObject  GetHIObject () const
  Return an internal pointer.
bool  IsSDKComponent ()
  Return whether or not item is an SDK component.
bool  ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a source connection.
bool  ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a destination connection.
bool  ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a source connection.
bool  ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a destination connection.
bool  DisconnectDst (FBPlug *pDst)
  Remove a destination connection.
bool  DisconnectSrc (FBPlug *pSrc)
  Remove a source connection.
void  DisconnectAllSrc ()
  Remove all source connections.
void  DisconnectAllDst ()
  Remove all destination connections.
bool  DisconnectDstAt (int pIndex)
  Remove a destination connection at a specified index.
bool  DisconnectSrcAt (int pIndex)
  Remove a source connection at a specified index.
bool  ReplaceDstAt (int pIndex, FBPlug *pDst)
  Replace a destination connection at a specified index.
bool  ReplaceSrcAt (int pIndex, FBPlug *pSrc)
  Replace a source connection at a specified index.
bool  SwapSrc (int pIndexA, int pIndexB)
  Swap source connection at index A with source connection at index B.
bool  MoveSrcAt (int pIndex, int pAtIndex)
  Move source connection at pIndex to pAtIndex.
bool  MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc)
  Move source connection pSrc to the position of pAtSrc.
int  GetSrcCount ()
  Get source connection count.
FBPlug GetSrc (int pIndex)
  Get a source connection's plug at specified index.
FBConnectionType  GetSrcType (int pIndex)
  Get a source connection's type at specified index.
int  GetDstCount ()
  Get destination connection count.
FBPlug GetDst (int pIndex)
  Get a destination connection's plug at specified index.
FBConnectionType  GetDstType (int pIndex)
  Get a destination connection's type at specified index.
bool  BeginChange ()
  Begins a change on multiple plugs.
void  EndChange ()
  Ends a change on multiple plugs.
void  SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
  Set the plug's self modification flag.
bool  GetSelfModified (FBPlugModificationFlag pFlag)
  Tell if the plug's self has changed.
void  SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
  Set the plug's owned property/object's modification flag.
bool  GetContentModified (FBPlugModificationFlag pFlag)
  Tell if the plug's content has changed.
int  GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
  Get plug's modified src/dst property/object connection added/removed List.
bool  RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
  Revert the plug's modification to original status.
void  SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
  Set the plug's status flag.
bool  GetStatusFlag (FBPlugStatusFlag pStatus) const
  Tell if the plug's status has changed.
FBPlug GetOwner ()
  Get the owner of this plug.
FBPlug GetOwned (int pIndex)
  Get the owned plug at specified index.
int  GetOwnedCount ()
  Get the owned plug count.
virtual bool  PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
  PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.
virtual bool  PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
  PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.
virtual bool  PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
  PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.
FBScriptWrapper GetWrapper ()
  Return the wrapper interface of this FBObject.
void  AddWrapper (FBScriptWrapper *)
void  RemoveWrapper (FBScriptWrapper *)
Setup take Info to loaded or saved.

You need to use the appropriate constructor to fill up those take info before call these functions.

int  GetTakeCount () const
  Return the count of takes in the scene to saved or the file to loaded.
bool  GetTakeSelect (int pTakeIndex) const
  Return if true if the take will be saved or Loaded.
void  SetTakeSelect (int pTakeIndex, bool pSelect)
  Return if true if the take will be saved or Loaded.
const char *  GetTakeName (int pTakeIndex) const
  Take Original Name.
void  SetTakeName (int pTakeIndex, const char *pName)
  Take Original Name.
const char *  GetTakeDescription (int pTakeIndex) const
  Take Description.
void  SetTakeDescription (int pTakeIndex, const char *pDescription)
  Take Description.
const char *  GetTakeDestinationName (int pTakeIndex) const
  Take Destination Name upon save or load.
void  SetTakeDestinationName (int pTakeIndex, const char *pDestinationName)
  Take Destination Name upon save or load.
void *  operator new (size_t stAllocateBlock)
void *  operator new (size_t stAllocateBlock, int blockType, const char *filename, int linenumber)
void  operator delete (void *pvMem)
void  RegisterPropertyEvent (FBPropertyEvent *pPropertyEvent)
void  UnregisterPropertyEvent (FBPropertyEvent *pPropertyEvent)
void  InvalidatePropertyEventsParents ()

Static Public Member Functions

static int  GetInternalClassId ()
static void  FBComponentSetName (FBComponent *pObject, const char *pName)
static const char *  FBComponentGetName (FBComponent *pObject)
static void  FBComponentSetLongName (FBComponent *pObject, const char *pName)
static const char *  FBComponentGetLongName (FBComponent *pObject)
static void  PrintClassDefinitions ()
  Print out internal Class (ID) Definition table.

Public Attributes

DataFBComponent *  mLocalPtr
  Handle on DataFBComponent.
FBPropertyManager  PropertyList
  Read Only Property: Manages all of the properties for the component.
FBPropertyListComponent  Components
  List: List of components.
FBPropertyListComponent  Parents
  List: Parents.
FBPropertyBool  Selected
  Read Write Property: Selected property.
FBPropertyString  Name
  Read Write Property: Unique name of object.
FBPropertyString  LongName
  Read Write Property: Name and namespace for object.
FBPropertyFolder  Folder
  Read Write Property: The folder that contain this component.
KObject *  mDummyObject
  Internal Dummy Object for non KObject Components.
bool  mAllocated
  Contain the Allocation State of the Component.
Load/Save options.
Warning:
These options are not present in the history file. Thus will not be affected by 'SetOptionsFromHistory()' and 'SetHistoryFromOptions()'.
FBPropertyBool  UpdateRecentFiles
  Read Write Property: Set to true to update recent file list.
Load specific options.
Warning:
These options are not present in the history file. Thus will not be affected by 'SetOptionsFromHistory()' and 'SetHistoryFromOptions()'.
FBPropertyTakeSpanOnLoad  TakeSpan
  Read Write Property: Indicate how the take start and end point should be set.
Save specific options.

All of these options are false by default, except for 'EmbedMedia' which is true by default.

Warning:
These options are not present in the history file. Thus will not be affected by 'SetOptionsFromHistory()' and 'SetHistoryFromOptions()'.
FBPropertyFileFormatAndVersion  FileFormatAndVersion
  Read Write Property: File format and version chosen to save the scene.
FBPropertyBool  EmbedMedia
  Read Write Property: Embed all media in the FBX file itself.
FBPropertyBool  SaveSelectedModelsOnly
  Read Write Property: Indicate that only the selected models will be saved.
FBPropertyBool  KeepTransformHierarchy
  Read Write Property: Indicate whether we keep transform hierarchy when SaveSelectedModelsOnly is true.
FBPropertyBool  UseASCIIFormat
  Read Write Property: Indicate if the resulting FBX file will be in binary or ASCII mode.
FBPropertyInt  CacheSize
  Read Write Property: The Cached buffer size used to accelerate IO system.
FBPropertyBool  CompressArray
  Read Write Property: Indicate if the perform compression on the arrays values.
FBPropertyInt  CompressMinSize
  Read Write Property: Indicate if the minimum item size for compressing arrays.
FBPropertyInt  CompressLevel
  Read Write Property: The allowed level range for Compression is [0-9] where 0 equals no compression and 9 is as-much-as-we-can.
Scene settings options.
FBPropertyBool  BaseCameras
  Read Write Property: Consider base camera settings.
FBPropertyBool  CameraSwitcherSettings
  Read Write Property: Consider camera switcher settings.
FBPropertyBool  CurrentCameraSettings
  Read Write Property: Consider current camera settings.
FBPropertyBool  GlobalLightingSettings
  Read Write Property: Consider global Lighting settings.
FBPropertyBool  TransportSettings
  Read Write Property: Consider transport control settings.
Scene segmentation options
FBPropertyBool  FileReference
  Read Write property: Load/Save scene as FileReference.
FBPropertyBool  FileReferenceEdit
  Read Write Property: Load/Save the edits made to referenced objects or not.
FBPropertyString  NamespaceList
  Read Write Property: A list of namespaces separated by '~', On Load, duplicate the loaded objects into each namespace in the list.
Layer merge options
FBPropertyBool  RemoveEmptyLayer
  Read Write property: Remove empty animation layers that are in additive mode, without child or parent.
FBPropertyBool  ConsiderMuteSolo
  Read Write property: Consider the mute/solo settings to identify identical layer when merging.
Element settings options.
FBPropertyElementAction  Actors
  Read Write Property: Handling of the Actors elements.
FBPropertyElementAction  ActorFaces
  Read Write Property: Handling of the Actor Faces elements.
FBPropertyElementAction  Audio
  Read Write Property: Handling of the Audio elements.
FBPropertyElementAction  Bones
  Read Write Property: Handling of the Bones elements.
FBPropertyElementAction  Cameras
  Read Write Property: Handling of the Cameras elements.
FBPropertyElementAction  Characters
  Read Write Property: Handling of the Characters elements.
FBPropertyElementAction  CharacterFaces
  Read Write Property: Handling of the Character Faces elements.
FBPropertyElementAction  CharacterExtensions
  Read Write Property: Handling of the Character Extensions.
FBPropertyElementAction  Constraints
  Read Write Property: Handling of the Constraints elements.
FBPropertyElementAction  Devices
  Read Write Property: Handling of the Devices elements.
FBPropertyElementAction  FileReferences
  Read Write Property: Handling of the FileReferences elements.
FBPropertyElementAction  Groups
  Read Write Property: Handling of the Groups elements.
FBPropertyElementAction  KeyingGroups
  Read Write Property: Handling of the Keying Groups elements.
FBPropertyElementAction  Lights
  Read Write Property: Handling of the Lights elements.
FBPropertyElementAction  Materials
  Read Write Property: Handling of the Materials elements.
FBPropertyElementAction  Models
  Read Write Property: Handling of the Models elements.
FBPropertyElementAction  Notes
  Read Write Property: Handling of the Notes elements.
FBPropertyElementAction  OpticalData
  Read Write Property: Handling of the Optical Data elements.
FBPropertyElementAction  PhysicalProperties
  Read Write Property: Handling of the Physical Properties elements.
FBPropertyElementAction  Poses
  Read Write Property: Handling of the Poses elements.
FBPropertyElementAction  Scripts
  Read Write Property: Handling of the Scripts elements.
FBPropertyElementAction  Sets
  Read Write Property: Handling of the Sets elements.
FBPropertyElementAction  Shaders
  Read Write Property: Handling of the Shaders elements.
FBPropertyElementAction  Solvers
  Read Write Property: Handling of the Solvers elements.
FBPropertyElementAction  Story
  Read Write Property: Handling of the Story elements.
FBPropertyElementAction  Textures
  Read Write Property: Handling of the Textures elements.
FBPropertyElementAction  Video
  Read Write Property: Handling of the Video elements.
Element animation settings options.

Not all elements type have animation associated with them.

FBPropertyBool  ActorFacesAnimation
  Read Write Property: Handling of the Actor Faces animation.
FBPropertyBool  BonesAnimation
  Read Write Property: Handling of the Bones animation.
FBPropertyBool  CamerasAnimation
  Read Write Property: Handling of the Cameras animation.
FBPropertyBool  CharactersAnimation
  Read Write Property: Handling of the Characters animation.
FBPropertyBool  CharacterFacesAnimation
  Read Write Property: Handling of the Character Faces animation.
FBPropertyBool  ConstraintsAnimation
  Read Write Property: Handling of the Constraints animation.
FBPropertyBool  DevicesAnimation
  Read Write Property: Handling of the Devices animation.
FBPropertyBool  LightsAnimation
  Read Write Property: Handling of the Lights animation.
FBPropertyBool  MaterialsAnimation
  Read Write Property: Handling of the Materials animation.
FBPropertyBool  ModelsAnimation
  Read Write Property: Handling of the Models animation.
FBPropertyBool  NotesAnimation
  Read Write Property: Handling of the Notes animation.
FBPropertyBool  PhysicalPropertiesAnimation
  Read Write Property: Handling of the Physical Properties animation.
FBPropertyBool  ShadersAnimation
  Read Write Property: Handling of the Shaders animation.
FBPropertyBool  SolversAnimation
  Read Write Property: Handling of the Solvers animation.
FBPropertyBool  StoryAnimation
  Read Write Property: Handling of the Story animation (animatable properties on story objects).
FBPropertyBool  TexturesAnimation
  Read Write Property: Handling of the Textures animation.
Save Character & Animation settings options.
FBPropertyBool  SaveCharacter
  Read Write Property: Set to true if the character should be saved when call FBApplication::SaveCharacterRigAndAnimation.
FBPropertyBool  SaveControlSet
  Read Write Property: Set to true if the rig (and its children) should be saved when call FBApplication::SaveCharacterRigAndAnimation.
FBPropertyBool  SaveCharacterExtensions
  Read Write Property: Set to true if the character extensions (and their children) should be saved when call FBApplication::SaveCharacterRigAndAnimation.
FBPropertyBool  ClearSelectionBeforeSave
  Read Write Property: Set to true if the current selected objects shouldn't saved when call FBApplication::SaveCharacterRigAndAnimation.
Load Character & Animation settings options.
FBPropertyCharacterLoadAnimationMethod  TransferMethod
  Read Write Property: How should the animation should be transfered on the target rig.
FBPropertyBool  ProcessAnimationOnExtension
  Read Write Property: Set to true if animation on character extensions should also be transferred.
FBPropertyBool  ReplaceControlSet
  Read Write Property: Set to true if the character extensions (and their children) should be saved when call FBApplication::SaveCharacterRigAndAnimation.
FBPropertyBool  ResetDOF
  Read Write Property: Set to true if we should change the limits on the target rig.
FBPropertyBool  ResetHierarchy
  Read Write Property: Set to true if we should reset the character hierarchy.
FBPropertyBool  RemoveConstraintReference
  Read Write Property: Set to true if we should remove constraint reference.
FBPropertyBool  CopyCharacterExtensions
  Read Write Property: pCopyMissingExtensions Set to true if the character extensions on the rig in the file should be copied to the target rig.
FBPropertyBool  RetargetOnBaseLayer
  Read Write Property: If the transfer method is retarget, set this parameter to control where the retarget correction will be made (on base layer or on another layer).
FBPropertyBool  IgnoreConflicts
  Read Write Property: Set to true to ignore conflicts between objects in character extensions and objects in the scene.
Dialog UI options.
FBPropertyBool  ShowFileDialog
  Read Write Property: Set to true if want to pop up dialog for FileName, Format, Embed, Compression, UseTakeName, OneTakePerFile.
FBPropertyBool  ShowOptionsDialog
  Read Write Property: Set to true if want to pop up options dialog for detail settings.
FBPropertyBool  SetPropertyStaticIfPossible
  Read Write Property: Set to false if want to keep properties' animated flag even when they are not really animated(no keyframe data) while retrieving/storing.

Static Public Attributes

static int  TypeInfo
  Contains the Type information of the object.
static const char *  ClassGroupName
  ClassGroupName of the object.

Protected Attributes

FBString  mName
  Name of the component.
HIObject  mObject
  Handle on the Plug.
bool  mSDKComponent
  bool Plug is an SDK component.

Static Protected Attributes

static int  mGlobalTypeInfo
  Represente the Type Index.

Friends

K_DLLIMPORT friend int  __FBRegisterTypeInfo (int pInternalClassId)
  __FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.

Constructor & Destructor Documentation

FBFbxOptions::FBFbxOptions ( bool  pLoad,
const char *  pFilePathToLoad = NULL,
HIObject  pObject = NULL 
)

Constructor.

Create a FBFbxOption to be used in FBApplication Save/Load with default settings.

Parameters:
pLoad If true, will init option for a default Load (Append all elements and animation). If false will initialized options for a default Save (Save all elements and animation).
pFilePathToLoad If pLoad is true, the client code should pass the file path to load to collect the take info; ignore when pLoad is false.
pObject For internal use only.

Member Function Documentation

void FBFbxOptions::SetAll ( FBElementAction  pElementAction,
bool  pAnimation 
)

Set All Options.

Initialize all loading/saving properties to ElementAction and animation specified.

Parameters:
pElementAction Default value for all FBPropertyElementAction properties.
pAnimation Default value for all Animation properties.
void FBFbxOptions::SaveToString ( FBString pString,
FBOptionsContext  context 
)

Serialize all options to a string Serialize all options to a string specifying a context.

Parameters:
pString The string containing all settings, target of serializing
context The context to be used when serializing
void FBFbxOptions::SetFromString ( const char *  pString,
FBOptionsContext  context 
)

Set all options from string Set all parameters from a formatted string (previously serialized with SaveToString)

Parameters:
pString The string containing all settings. See SaveToFile
context The context to be used when de-serializing
int FBFbxOptions::GetTakeCount ( ) const

Return the count of takes in the scene to saved or the file to loaded.

Warning:
You need to use appropriate constructor to be able to take infos.
bool FBFbxOptions::GetTakeSelect ( int  pTakeIndex ) const

Return if true if the take will be saved or Loaded.

Parameters:
pTakeIndex index of take to get.
void FBFbxOptions::SetTakeSelect ( int  pTakeIndex,
bool  pSelect 
)

Return if true if the take will be saved or Loaded.

Parameters:
pTakeIndex index of take to set
pSelect set true if should be saved or loaded.
const char* FBFbxOptions::GetTakeName ( int  pTakeIndex ) const

Take Original Name.

Parameters:
pTakeIndex index of take to get.
void FBFbxOptions::SetTakeName ( int  pTakeIndex,
const char *  pName 
)

Take Original Name.

Parameters:
pTakeIndex index of take to set.
pName take name to set
const char* FBFbxOptions::GetTakeDescription ( int  pTakeIndex ) const

Take Description.

Parameters:
pTakeIndex index of take to get.
void FBFbxOptions::SetTakeDescription ( int  pTakeIndex,
const char *  pDescription 
)

Take Description.

Parameters:
pTakeIndex index of take to set.
pDescription take description to set
const char* FBFbxOptions::GetTakeDestinationName ( int  pTakeIndex ) const

Take Destination Name upon save or load.

Parameters:
pTakeIndex index of take to get.
void FBFbxOptions::SetTakeDestinationName ( int  pTakeIndex,
const char *  pDestinationName 
)

Take Destination Name upon save or load.

Parameters:
pTakeIndex index of take to set.
pDestinationName take description to set
void FBFbxOptions::SetNamespaceList ( const FBStringList pNamespaceList )

SetNamespaceList upon save or load.

Parameters:
pNamespaceList namespace list to set
FBStringList FBFbxOptions::GetNamespaceList ( )

GetNamespaceList upon save or load.

Returns:
namespace list
FBComponent::GetInternalClassId ( ) [static, inherited]
Returns:
Internal class Id

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

virtual bool FBComponent::FBCreate ( ) [virtual, inherited]
virtual void FBComponent::FBDestroy ( ) [virtual, inherited]
virtual bool FBComponent::SetHIObject ( HIObject  pObject,
bool  pSDKComponent 
) [override, virtual, inherited]

Assign component to an internal pointer.

Reimplemented from FBPlug.

virtual int FBComponent::PropertyAdd ( FBProperty pProperty ) [virtual, inherited]

Add a property to the component's property manager.

Parameters:
pProperty The property to add to the property manager.
Returns:
Index in the property array where property was inserted.
bool FBComponent::PropertyAddReferenceProperty ( FBProperty pReferenceProperty ) [inherited]

Add a reference property to the component's property manager.

Parameters:
pReferenceProperty The property to from an other object to add a reference to (property cannot be a custom ORSDK property).
Returns:
True if the reference property could be added.
void FBComponent::PropertyRemove ( FBProperty pProperty ) [inherited]

Remove a Property from the component's Property manager.

If the property was dynamically allocated, it is deleted.

Parameters:
pProperty The property to remove from the property manager.
void FBComponent::PropertyGetModifiedList ( FBArrayTemplate< FBProperty * > &  pPropList,
FBPlugModificationFlag  pModificationFlags 
) [inherited]

Get list of properties which have been modified since last loading.

Parameters:
pPropList property list to hold the modified properties.
pModificationFlags type of modification to query.
FBProperty* FBComponent::PropertyCreate ( const char *  pName,
FBPropertyType  pType,
const char *  pDataType,
bool  pAnimatable,
bool  pIsUser = false,
FBProperty pReferenceSource = NULL 
) [inherited]

Create user or dynamic property.

Parameters:
pName The name of the property.
pType Type of the property. See enum FBPropertyType.
pDataType DataType of the property.
pAnimatable To specify if the property can be animated.
pIsUser To specify if the property is available as a custom property or dynamic and attached to the object.
pReferenceSource Specifies the property that a reference refers to.
FBObjectFlag FBComponent::GetObjectFlags ( ) [inherited]

Get all Object Flags (concatenated).

Returns:
Get all object flags in one call. Flags can be concatenated.
void FBComponent::SetObjectFlags ( FBObjectFlag  pFlags ) [inherited]

SetObjectFlags.

Parameters:
pFlags Set flag values. Note: this function overwrites all flags with those passed in parameter.
bool FBComponent::HasObjectFlags ( FBObjectFlag  pFlags ) [inherited]

Check whether a specific object flag is enabled.

Parameters:
pFlags Flags to check if they are present.
Returns:
True if all flags in pFlags are enabled.
void FBComponent::EnableObjectFlags ( FBObjectFlag  pFlags ) [inherited]

Enable a specific Object Flags.

Parameters:
pFlags Flags to enable.
void FBComponent::DisableObjectFlags ( FBObjectFlag  pFlags ) [inherited]

Disable a specific Object Flags.

Parameters:
pFlags Flags to disable.
void FBComponent::SetObjectStatus ( FBObjectStatus  pStatus,
bool  pValue 
) [inherited]

Enable/Disable a specific Object Status.

Parameters:
pStatus Status to change.
pValue Value to change the status to.
bool FBComponent::GetObjectStatus ( FBObjectStatus  pStatus ) [inherited]

Check to see if an object status is enabled.

Parameters:
pStatus Status to query.
bool FBComponent::ProcessNamespaceHierarchy ( FBNamespaceAction  pNamespaceAction,
const char *  pNamespaceName,
const char *  pReplaceTo = NULL,
bool  pAddRight = true 
) [inherited]

ProcessNamespaceHierarchy.

New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This recursive function goes through the whole hierarchy (children) to add/replace the prefix. If you need to work on a single object, use the ProcessObjectPrefix function.

Parameters:
pNamespaceAction Which operation to do on the hierarchy (children).
pNamespaceName The Namespace name on Add/Delete or the prefix to replace in case of replace.
pReplaceTo The new Namespace Name or NULL in case of add or delete.
pAddRight Whether to add the namespace on right-most or left-most side or other namespace.
Returns:
return true if process successful.
bool FBComponent::ProcessObjectNamespace ( FBNamespaceAction  pNamespaceAction,
const char *  pNamespaceName,
const char *  pReplaceTo = NULL,
bool  pAddRight = true 
) [inherited]

ProcessObjectNamespace.

New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This function is the same as ProcessNamespaceHierarchy except that it applies only on the current object and not to the object's children.

Parameters:
pNamespaceAction Which operation to do on the hierarchy (children).
pNamespaceName The Namespace name on Add/Delete or the prefix to replace in case of replace.
pReplaceTo The new Namespace Name or NULL in case of add or delete.
pAddRight Whether to add the namespace on right-most or left-most side or other namespace.
Returns:
return true if process successful.
virtual const char* FBComponent::ClassName ( ) [override, virtual, inherited]

Get the class name.

Returns:
The class name (i.e. "FBComponent").

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

virtual bool FBComponent::UseCustomPropertyViewSet ( ) const [inline, virtual, inherited]

Use the custom property viewSet or not.

To have custom property view for custom subclass, modification bin/config/propertyview.fbx is required.

Returns:
False if to use internal corresponding object's viewSet of the parent class.

Definition at line 791 of file fbcomponent.h.

{ return true; }
const char* FBComponent::GetFullName ( void  ) [inherited]

Get the full name.

Returns:
the full name of the component.
void FBComponent::SetOwnerNamespace ( FBNamespace pOwnerNSObj ) [inherited]

Set the owner Namespace object.

FBNamespace* FBComponent::GetOwnerNamespace ( void  ) [inherited]

Get the owner Namespace object.

Returns:
the owner Namespace object
FBFileReference* FBComponent::GetOwnerFileReference ( void  ) [inherited]

Get the owner FileReference object.

Returns:
the owner FileReference object
void FBComponent::HardSelect ( ) [inherited]

HardSelect.

Selects the object, and emits a hard select event for UI update notification.

void* FBComponent::operator new ( size_t  stAllocateBlock ) [inherited]
void* FBComponent::operator new ( size_t  stAllocateBlock,
int  blockType,
const char *  filename,
int  linenumber 
) [inherited]
void FBComponent::operator delete ( void *  pvMem ) [inherited]
void FBComponent::RegisterPropertyEvent ( FBPropertyEvent pPropertyEvent ) [inherited]
void FBComponent::UnregisterPropertyEvent ( FBPropertyEvent pPropertyEvent ) [inherited]
void FBComponent::InvalidatePropertyEventsParents ( ) [inherited]
FBComponent::ICallback_Declare ( K_IMPLEMENTATION  ) [inherited]

Reimplemented from FBPlug.

Reimplemented in FBModel, and FBVisualComponent.

virtual bool FBComponent::Is ( int  pTypeId ) [virtual, inherited]

Returns true if object is of type TypeId.

Parameters:
pTypeId TypeId to compare object to.
Returns:
Result of the comparison.

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

virtual int FBComponent::GetTypeId ( ) [virtual, inherited]

GetTypeId( int pTypeId )

Returns:
The TypeInfo of the object

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

static void FBComponent::FBComponentSetName ( FBComponent pObject,
const char *  pName 
) [static, inherited]
static const char* FBComponent::FBComponentGetName ( FBComponent pObject ) [static, inherited]
static void FBComponent::FBComponentSetLongName ( FBComponent pObject,
const char *  pName 
) [static, inherited]
static const char* FBComponent::FBComponentGetLongName ( FBComponent pObject ) [static, inherited]
void FBComponent::KObjectEvent ( HIRegister  pView,
HKEventBase  pEvent 
) [inherited]
virtual HIObject FBPlug::GetHIObject ( ) const [virtual, inherited]

Return an internal pointer.

bool FBPlug::IsSDKComponent ( ) [inherited]

Return whether or not item is an SDK component.

bool FBPlug::ConnectSrc ( FBPlug pSrc,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a source connection.

Parameters:
pSrc Source plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ConnectDst ( FBPlug pDst,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a destination connection.

Parameters:
pDst Destination plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False)
bool FBPlug::ConnectSrcAt ( int  pDst_SrcIndex,
FBPlug pSrc,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a source connection.

Parameters:
pDst_SrcIndex Index that tells where to add this source connection in the destination's connection list. if index is out of bound, and this source connection will be appended at the end.
pSrc Source plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ConnectDstAt ( int  pSrc_DstIndex,
FBPlug pDst,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a destination connection.

Parameters:
pSrc_DstIndex Index that tells where to add this destination connection in the source's connection list. if index is out of bound, and this destination connection will be appended at the end.
pDst Destination plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectDst ( FBPlug pDst ) [inherited]

Remove a destination connection.

Parameters:
pDst Destination plug.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectSrc ( FBPlug pSrc ) [inherited]

Remove a source connection.

Parameters:
pSrc Source plug.
Returns:
A boolean indicating success (True) or failure (False).
void FBPlug::DisconnectAllSrc ( ) [inherited]

Remove all source connections.

void FBPlug::DisconnectAllDst ( ) [inherited]

Remove all destination connections.

bool FBPlug::DisconnectDstAt ( int  pIndex ) [inherited]

Remove a destination connection at a specified index.

Parameters:
pIndex Destination plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectSrcAt ( int  pIndex ) [inherited]

Remove a source connection at a specified index.

Parameters:
pIndex Source plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ReplaceDstAt ( int  pIndex,
FBPlug pDst 
) [inherited]

Replace a destination connection at a specified index.

Parameters:
pIndex Destination plug index.
pDst Plug that will replace the other at index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ReplaceSrcAt ( int  pIndex,
FBPlug pSrc 
) [inherited]

Replace a source connection at a specified index.

Parameters:
pIndex Source plug index.
pSrc Plug that will replace the other at index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::SwapSrc ( int  pIndexA,
int  pIndexB 
) [inherited]

Swap source connection at index A with source connection at index B.

Parameters:
pIndexA Plug index.
pIndexB Other plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::MoveSrcAt ( int  pIndex,
int  pAtIndex 
) [inherited]

Move source connection at pIndex to pAtIndex.

Parameters:
pIndex Plug current index.
pAtIndex Plug new index.
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This is not like the swap function since the connection at pAtIndex is untouched.
bool FBPlug::MoveSrcAt ( FBPlug pSrc,
FBPlug pAtSrc 
) [inherited]

Move source connection pSrc to the position of pAtSrc.

Parameters:
pSrc Plug.
pAtSrc Plug that mark where we want to insert (will insert before this one).
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This is not like the swap function since the connection at pAtSrc is untouched.
int FBPlug::GetSrcCount ( ) [inherited]

Get source connection count.

Returns:
Total sources connections count.
FBPlug* FBPlug::GetSrc ( int  pIndex ) [inherited]

Get a source connection's plug at specified index.

Parameters:
pIndex Index of the source connection's plug.
Returns:
Source plug at specified index.
FBConnectionType FBPlug::GetSrcType ( int  pIndex ) [inherited]

Get a source connection's type at specified index.

Parameters:
pIndex Index of the source connection's type.
Returns:
Source connection's type at specified index.
int FBPlug::GetDstCount ( ) [inherited]

Get destination connection count.

Returns:
Total destinations connections count.
FBPlug* FBPlug::GetDst ( int  pIndex ) [inherited]

Get a destination connection's plug at specified index.

Parameters:
pIndex Index of the destination connection's plug.
Returns:
Destination plug at specified index.
FBConnectionType FBPlug::GetDstType ( int  pIndex ) [inherited]

Get a destination connection's type at specified index.

Parameters:
pIndex Index of the destination connection's type.
Returns:
Destination connection's type at specified index.
bool FBPlug::BeginChange ( ) [inherited]

Begins a change on multiple plugs.

Returns:
A boolean indicating success (True) or failure (False).
void FBPlug::EndChange ( ) [inherited]

Ends a change on multiple plugs.

void FBPlug::SetSelfModified ( FBPlugModificationFlag  pFlag,
bool  pBool 
) [inherited]

Set the plug's self modification flag.

Parameters:
pFlag bitwise AND of self modification flags.
pBool true if self changed.
bool FBPlug::GetSelfModified ( FBPlugModificationFlag  pFlag ) [inherited]

Tell if the plug's self has changed.

Parameters:
pFlag bitwise AND of self modification flags.
Returns:
true if self changed
void FBPlug::SetContentModified ( FBPlugModificationFlag  pFlag,
bool  pBool 
) [inherited]

Set the plug's owned property/object's modification flag.

Parameters:
pFlag bitwise AND of content modification flags.
pBool true if content has modification.
bool FBPlug::GetContentModified ( FBPlugModificationFlag  pFlag ) [inherited]

Tell if the plug's content has changed.

Parameters:
pFlag bitwise AND of content modification flags.
Returns:
true if content connection changed.
int FBPlug::GetPlugConnectionModifiedList ( FBPlugList pPlugList,
FBPlugModificationFlag  pConnectionModificatonFlag,
bool  pAddRemove 
) [inherited]

Get plug's modified src/dst property/object connection added/removed List.

Parameters:
pPlugList plug list to fill up.
pConnectionModificatonFlag Src/Dst Property/Object connection modification flag.
pAddRemove Ask for the added list if true, removed list if false.
Returns:
count of list;
bool FBPlug::RevertModification ( FBPlugModificationFlag  pFlag = kFBAllModifiedMask ) [inherited]

Revert the plug's modification to original status.

Parameters:
pFlag the type of modification to be reverted.
Returns:
true if revert successfully.
void FBPlug::SetStatusFlag ( FBPlugStatusFlag  pStatus,
bool  pValue 
) [inherited]

Set the plug's status flag.

Parameters:
pStatus bitwise AND of status flags.
pValue true if status has modification.
bool FBPlug::GetStatusFlag ( FBPlugStatusFlag  pStatus ) const [inherited]

Tell if the plug's status has changed.

Parameters:
pStatus bitwise AND of self modification flags.
Returns:
true if self changed
FBPlug* FBPlug::GetOwner ( ) [inherited]

Get the owner of this plug.

Very useful for properties since they are plugs too.

Returns:
The owner of this plug.
FBPlug* FBPlug::GetOwned ( int  pIndex ) [inherited]

Get the owned plug at specified index.

Parameters:
pIndex Index of the owned plug to get.
Returns:
The owned plug at specified index.
int FBPlug::GetOwnedCount ( ) [inherited]

Get the owned plug count.

Returns:
The owned plug count.
virtual bool FBPlug::PlugDataNotify ( FBConnectionAction  pAction,
FBPlug pThis,
void *  pData = NULL,
void *  pDataOld = NULL,
int  pDataSize = 0 
) [virtual, inherited]

PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pData Current data, meaning depends of plug action.
pDataOld Previous data, meaning depends of plug action.
pDataSize Size of data.
Returns:
unused should return true
virtual bool FBPlug::PlugStateNotify ( FBConnectionAction  pAction,
FBPlug pThis,
void *  pData = NULL,
void *  pDataOld = NULL,
int  pDataSize = 0 
) [virtual, inherited]

PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pData Current data, meaning depends of plug action.
pDataOld Previous data, meaning depends of plug action.
pDataSize Size of data.
Returns:
unused should return true except in the case of property rename kFBRename
virtual bool FBPlug::PlugNotify ( FBConnectionAction  pAction,
FBPlug pThis,
int  pIndex,
FBPlug pPlug = NULL,
FBConnectionType  pConnectionType = kFBConnectionTypeNone,
FBPlug pNewPlug = NULL 
) [virtual, inherited]

PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pIndex Index of the plug.
pPlug Other plug concerned.
pConnectionType Connection type between the plugs.
pNewPlug New plug (for the replace event).
Returns:
should by default return true except in the case of connection requests (kFBRequestConnectSrc or kFBRequestConnectDst)
static void FBPlug::PrintClassDefinitions ( ) [static, inherited]

Print out internal Class (ID) Definition table.

For internal debug purpose only.

FBScriptWrapper* FBWrapperHolder::GetWrapper ( ) [inherited]

Return the wrapper interface of this FBObject.

void FBWrapperHolder::AddWrapper ( FBScriptWrapper ) [inherited]
void FBWrapperHolder::RemoveWrapper ( FBScriptWrapper ) [inherited]

Friends And Related Function Documentation

K_DLLIMPORT friend int __FBRegisterTypeInfo ( int  pInternalClassId ) [friend, inherited]

__FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.


Member Data Documentation

Read Write Property: Set to true to update recent file list.

Definition at line 153 of file fbfbxoptions.h.

FBPropertyTakeSpanOnLoad FBFbxOptions::TakeSpan

Read Write Property: Indicate how the take start and end point should be set.

By default it is read from the file.

Definition at line 159 of file fbfbxoptions.h.

FBPropertyFileFormatAndVersion FBFbxOptions::FileFormatAndVersion

Read Write Property: File format and version chosen to save the scene.

Definition at line 168 of file fbfbxoptions.h.

Read Write Property: Embed all media in the FBX file itself.

When saving in ASCII mode it is not possible to embed media.

Definition at line 169 of file fbfbxoptions.h.

Read Write Property: Indicate that only the selected models will be saved.

Definition at line 170 of file fbfbxoptions.h.

Read Write Property: Indicate whether we keep transform hierarchy when SaveSelectedModelsOnly is true.

Default value is false to ensure consistent behavior with SaveSelected operation via file menu.

Definition at line 171 of file fbfbxoptions.h.

Read Write Property: Indicate if the resulting FBX file will be in binary or ASCII mode.

Definition at line 172 of file fbfbxoptions.h.

Read Write Property: The Cached buffer size used to accelerate IO system.

Definition at line 173 of file fbfbxoptions.h.

Read Write Property: Indicate if the perform compression on the arrays values.

Definition at line 174 of file fbfbxoptions.h.

Read Write Property: Indicate if the minimum item size for compressing arrays.

Definition at line 175 of file fbfbxoptions.h.

Read Write Property: The allowed level range for Compression is [0-9] where 0 equals no compression and 9 is as-much-as-we-can.

Definition at line 176 of file fbfbxoptions.h.

Read Write Property: Consider base camera settings.

Definition at line 183 of file fbfbxoptions.h.

Read Write Property: Consider camera switcher settings.

Definition at line 184 of file fbfbxoptions.h.

Read Write Property: Consider current camera settings.

Definition at line 185 of file fbfbxoptions.h.

Read Write Property: Consider global Lighting settings.

Definition at line 186 of file fbfbxoptions.h.

Read Write Property: Consider transport control settings.

Definition at line 187 of file fbfbxoptions.h.

Read Write property: Load/Save scene as FileReference.

Definition at line 193 of file fbfbxoptions.h.

Read Write Property: Load/Save the edits made to referenced objects or not.

Definition at line 194 of file fbfbxoptions.h.

Read Write Property: A list of namespaces separated by '~', On Load, duplicate the loaded objects into each namespace in the list.

Definition at line 195 of file fbfbxoptions.h.

Read Write property: Remove empty animation layers that are in additive mode, without child or parent.

Definition at line 201 of file fbfbxoptions.h.

Read Write property: Consider the mute/solo settings to identify identical layer when merging.

Definition at line 202 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Actors

Read Write Property: Handling of the Actors elements.

Definition at line 208 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::ActorFaces

Read Write Property: Handling of the Actor Faces elements.

Definition at line 209 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Audio

Read Write Property: Handling of the Audio elements.

Definition at line 210 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Bones

Read Write Property: Handling of the Bones elements.

Definition at line 211 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Cameras

Read Write Property: Handling of the Cameras elements.

Definition at line 212 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Characters

Read Write Property: Handling of the Characters elements.

Definition at line 213 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::CharacterFaces

Read Write Property: Handling of the Character Faces elements.

Definition at line 214 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::CharacterExtensions

Read Write Property: Handling of the Character Extensions.

Definition at line 215 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Constraints

Read Write Property: Handling of the Constraints elements.

Definition at line 216 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Devices

Read Write Property: Handling of the Devices elements.

Definition at line 217 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::FileReferences

Read Write Property: Handling of the FileReferences elements.

Definition at line 218 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Groups

Read Write Property: Handling of the Groups elements.

Definition at line 219 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::KeyingGroups

Read Write Property: Handling of the Keying Groups elements.

Definition at line 220 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Lights

Read Write Property: Handling of the Lights elements.

Definition at line 221 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Materials

Read Write Property: Handling of the Materials elements.

Definition at line 222 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Models

Read Write Property: Handling of the Models elements.

Definition at line 223 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Notes

Read Write Property: Handling of the Notes elements.

Definition at line 224 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::OpticalData

Read Write Property: Handling of the Optical Data elements.

Definition at line 225 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::PhysicalProperties

Read Write Property: Handling of the Physical Properties elements.

Definition at line 226 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Poses

Read Write Property: Handling of the Poses elements.

Definition at line 227 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Scripts

Read Write Property: Handling of the Scripts elements.

Definition at line 228 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Sets

Read Write Property: Handling of the Sets elements.

Definition at line 229 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Shaders

Read Write Property: Handling of the Shaders elements.

Definition at line 230 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Solvers

Read Write Property: Handling of the Solvers elements.

Definition at line 231 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Story

Read Write Property: Handling of the Story elements.

Definition at line 232 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Textures

Read Write Property: Handling of the Textures elements.

Definition at line 233 of file fbfbxoptions.h.

FBPropertyElementAction FBFbxOptions::Video

Read Write Property: Handling of the Video elements.

Definition at line 234 of file fbfbxoptions.h.

Read Write Property: Handling of the Actor Faces animation.

Definition at line 242 of file fbfbxoptions.h.

Read Write Property: Handling of the Bones animation.

Definition at line 243 of file fbfbxoptions.h.

Read Write Property: Handling of the Cameras animation.

Definition at line 244 of file fbfbxoptions.h.

Read Write Property: Handling of the Characters animation.

Definition at line 245 of file fbfbxoptions.h.

Read Write Property: Handling of the Character Faces animation.

Definition at line 246 of file fbfbxoptions.h.

Read Write Property: Handling of the Constraints animation.

Definition at line 247 of file fbfbxoptions.h.

Read Write Property: Handling of the Devices animation.

Definition at line 248 of file fbfbxoptions.h.

Read Write Property: Handling of the Lights animation.

Definition at line 249 of file fbfbxoptions.h.

Read Write Property: Handling of the Materials animation.

Definition at line 250 of file fbfbxoptions.h.

Read Write Property: Handling of the Models animation.

Definition at line 251 of file fbfbxoptions.h.

Read Write Property: Handling of the Notes animation.

Definition at line 252 of file fbfbxoptions.h.

Read Write Property: Handling of the Physical Properties animation.

Definition at line 253 of file fbfbxoptions.h.

Read Write Property: Handling of the Shaders animation.

Definition at line 254 of file fbfbxoptions.h.

Read Write Property: Handling of the Solvers animation.

Definition at line 255 of file fbfbxoptions.h.

Read Write Property: Handling of the Story animation (animatable properties on story objects).

Definition at line 256 of file fbfbxoptions.h.

Read Write Property: Handling of the Textures animation.

Definition at line 257 of file fbfbxoptions.h.

Read Write Property: Set to true if the character should be saved when call FBApplication::SaveCharacterRigAndAnimation.

Definition at line 263 of file fbfbxoptions.h.

Read Write Property: Set to true if the rig (and its children) should be saved when call FBApplication::SaveCharacterRigAndAnimation.

Definition at line 264 of file fbfbxoptions.h.

Read Write Property: Set to true if the character extensions (and their children) should be saved when call FBApplication::SaveCharacterRigAndAnimation.

Definition at line 265 of file fbfbxoptions.h.

Read Write Property: Set to true if the current selected objects shouldn't saved when call FBApplication::SaveCharacterRigAndAnimation.

Definition at line 266 of file fbfbxoptions.h.

FBPropertyCharacterLoadAnimationMethod FBFbxOptions::TransferMethod

Read Write Property: How should the animation should be transfered on the target rig.

Definition at line 274 of file fbfbxoptions.h.

Read Write Property: Set to true if animation on character extensions should also be transferred.

Definition at line 275 of file fbfbxoptions.h.

Read Write Property: Set to true if the character extensions (and their children) should be saved when call FBApplication::SaveCharacterRigAndAnimation.

Definition at line 276 of file fbfbxoptions.h.

Read Write Property: Set to true if we should change the limits on the target rig.

Definition at line 277 of file fbfbxoptions.h.

Read Write Property: Set to true if we should reset the character hierarchy.

Definition at line 278 of file fbfbxoptions.h.

Read Write Property: Set to true if we should remove constraint reference.

Definition at line 279 of file fbfbxoptions.h.

Read Write Property: pCopyMissingExtensions Set to true if the character extensions on the rig in the file should be copied to the target rig.

Definition at line 280 of file fbfbxoptions.h.

Read Write Property: If the transfer method is retarget, set this parameter to control where the retarget correction will be made (on base layer or on another layer).

Definition at line 281 of file fbfbxoptions.h.

Read Write Property: Set to true to ignore conflicts between objects in character extensions and objects in the scene.

Conflicting objects will be merged in the extension

Definition at line 282 of file fbfbxoptions.h.

Read Write Property: Set to true if want to pop up dialog for FileName, Format, Embed, Compression, UseTakeName, OneTakePerFile.

Definition at line 288 of file fbfbxoptions.h.

Read Write Property: Set to true if want to pop up options dialog for detail settings.

Definition at line 289 of file fbfbxoptions.h.

Read Write Property: Set to false if want to keep properties' animated flag even when they are not really animated(no keyframe data) while retrieving/storing.

Definition at line 290 of file fbfbxoptions.h.

DataFBComponent* FBComponent::mLocalPtr [inherited]

Handle on DataFBComponent.

Reimplemented in FBCustomManager.

Definition at line 650 of file fbcomponent.h.

FBString FBComponent::mName [protected, inherited]

Name of the component.

Definition at line 653 of file fbcomponent.h.

int FBComponent::TypeInfo [static, inherited]

Contains the Type information of the object.

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

Definition at line 658 of file fbcomponent.h.

Read Only Property: Manages all of the properties for the component.

Definition at line 838 of file fbcomponent.h.

List: List of components.

Reimplemented in FBScene, and FBPropertyInspector.

Definition at line 839 of file fbcomponent.h.

List: Parents.

Definition at line 840 of file fbcomponent.h.

Read Write Property: Selected property.

Definition at line 841 of file fbcomponent.h.

Read Write Property: Unique name of object.

Reimplemented in FBAssetMng, FBConsoleChannel, FBTriggerGroup, FBTrigger, FBMotionClip, and FBTool.

Definition at line 842 of file fbcomponent.h.

Read Write Property: Name and namespace for object.

Definition at line 843 of file fbcomponent.h.

FBPropertyFolder FBComponent::Folder [inherited]

Read Write Property: The folder that contain this component.

Definition at line 846 of file fbcomponent.h.

KObject* FBComponent::mDummyObject [inherited]

Internal Dummy Object for non KObject Components.

Definition at line 871 of file fbcomponent.h.

const char* FBPlug::ClassGroupName [static, inherited]

ClassGroupName of the object.

Definition at line 444 of file fbplug.h.

bool FBPlug::mAllocated [inherited]

Contain the Allocation State of the Component.

Definition at line 450 of file fbplug.h.

int FBPlug::mGlobalTypeInfo [static, protected, inherited]

Represente the Type Index.

Definition at line 500 of file fbplug.h.

HIObject FBPlug::mObject [protected, inherited]

Handle on the Plug.

Definition at line 502 of file fbplug.h.

bool FBPlug::mSDKComponent [protected, inherited]

bool Plug is an SDK component.

Definition at line 503 of file fbplug.h.


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