Classes | Defines | Typedefs | Enumerations | Functions

fbcomponent.h File Reference

This reference page is linked to from the following overview topics: Your First Python Program, Using C++ with MotionBuilder, Data types & properties, FBModel - Transformation Data and the Scene Graph, Rigid Body Physics, Joint Chains.

Basic class definitions. More...

#include <kaydaradef.h>
#include <fbsdk/fblibrary.h>
#include <fbsdk/fbplug.h>
#include <fbsdk/fbarray.h>
#include <fbsdk/fbstring.h>
#include <fbsdk/fbproperties.h>

Go to the source code of this file.

Classes
class   FBPropertyListComponentBase
  PropertyList: Component. More...
class   FBPropertyListComponent
  PropertyList: Concrete class for PropertyList of component More...
class   FBPropertyListObject
  List of scene objects. More...
class   FBComponent
  MotionBuilder SDK base class. More...
class   FBEvent
  Base Event class. More...
class   FBEventConnectionNotify
  Connection notify event class. More...
class   FBEventConnectionDataNotify
  Connection notify event class. More...
class   FBEventConnectionStateNotify
  Connection notify event class. More...
class   FBEventConnectionKeyingNotify
class   FBLibraryBase
  Library class for DLL registration. More...
class   FBLibrary
  Library class for DLL registration. More...
class   FBCustomManager
  Custom manager class for user controlled observer objects. More...

Defines
#define  FBSDK_DLL   K_DLLIMPORT
  Be sure that FBSDK_DLL is defined only once...
#define  FB_DEFAULT_SDK_ICON   "openreality_noicon.png"
  Define SDK icon filename.
#define  __FBClassInit   mLocalPtr = NULL;
  For internal use only.
#define  __FBClassInitSDKComponent(pObjectToWrappedIsAllocated)
  For internal use onlyL decide if we need to delete the corresponding KObject.
#define  __FBClassImplementation(ThisComponent, pInternalClassId)
  For internal use only.
#define  __FBClassImplementationGroup(ThisComponent, pInternalClass)
#define  __FBClassDeclare(Name, Parent)
#define  __FBClassDeclareGroup(Name, Parent)
  For internal use only.
#define  FBStorableClassImplementation(ClassName, Type)
  Storable Class implementation.
#define  FBElementClassImplementation(ClassName, IconFileName)
  Element Class implementation.
#define  FBShadingElementClassImplementation(ClassName, IconFileName)
  Shading Element Class implementation.
#define  FBStorableClassDeclare(Name, Parent)
  Storable Class declaration.
#define  FBPropertyInitComponent(Param, Type, PropName, Get, Set)
  Initialize a property: component.
#define  FBIS(Component, ComponentType)   ((Component) && (Component)->Is( ComponentType::TypeInfo ))
  Macro to verify the type of a component.
#define  FBRegisterEvent   ( Object, EventId, EventProc ) IQ( Object,IRegister)->Register ( EventId,(HICallback)this,(kICallbackHandler)EventProc );
  Event registration/unregistration.
#define  FBUnregisterEvent   ( Object, EventId, EventProc ) IQ( Object,IRegister)->Unregister ( EventId,(HICallback)this,(kICallbackHandler)EventProc );
  Event registration/unregistration.
#define  FBRegisterObject(LocalId, Path, Name, Description, Constructor, IsMultipleAllowed, IconFilename)   static int __R##LocalId = FBObject_Register( Path,Name,Description,Constructor,IsMultipleAllowed,IconFilename )
  Event registration/unregistration.
#define  FBDeclareUserObject(ClassName)
  Event registration/unregistration.
#define  FBLibraryDeclare(LibName)
  Declare the library for the application.
#define  FBLibraryModule(Name)   void FBModule##Name()
  FBLibraryModule Define a module registration call.
#define  FBLibraryRegister(ClassName)
  FBLibraryRegister Declare the module's registration functions.
#define  FBLibraryRegisterStorable(ClassName)
  FBLibraryRegisterStorable Declare the module's registration functions for storable classes.
#define  FBLibraryRegisterElement(ClassName)
  FBLibraryRegisterElement Declare the module's registration functions for element classes.
#define  FBLibraryRegisterShadingElement(ClassName)
  FBLibraryRegisterShadingElement Declare the module's registration functions for shading element classes.
#define  FBLibraryDeclareEnd
  Finish library declaration.
#define  FBCustomManagerImplementation(ThisComponent)   FBClassImplementation( ThisComponent ) \
  FBCustomManagerImplementation.
#define  FBRegisterCustomManager(ClassName)
  FBRegisterCustomManager.
#define  FBCustomManagerDeclare(ClassName)
  FBRegisterCustomDeclare.

Typedefs
typedef FBArrayTemplate
< FBComponent * > 		 FBComponentList
  typedef FBArrayTemplate<FBComponent*> FBComponentList;
typedef HIRegister  HISender
  HISender.
typedef HKEventBase  HKEvent
  HKEvent.
typedef void(ICallback::*  FBCallback )(HISender pSender, HKEvent pEvent)
  FBCallback.
typedef FBComponent  FBObject
  Equivalent to FBComponent for gradual transition.

Enumerations
enum   FBObjectFlag {
  kFBFlagSelectable = (1 << 0), kFBFlagDeletable = (1 << 1), kFBFlagSavable = (1 << 2), kFBFlagVisible = (1 << 3),
  kFBFlagClonable = (1 << 4), kFBFlagSystem = (1 << 5), kFBFlagNewable = (1 << 6), kFBFlagRenamable = (1 << 7),
  kFBFlagMergeable = (1 << 8), kFBFlagBrowsable = (1 << 9), kFBFlagParentable = (1 << 10), kFBFlagDetachable = (1 << 11),
  kFBFlagUndoable = (1 << 12), kFBFlagUndoableSeparately = (1 << 13), kFBFlagKeyable = (1 << 14), kFBFlagAllocated = (1 << 15),
  kFBFlagStory = (1 << 16), kFBFlagStorable6 = (1 << 17), kFBFlagStorableData6 = (1 << 18), kFBFlagStorableBlindData = (1 << 19),
  kFBFlagStorableBlindDataForceBinary = (1 << 20), kFBFlagUniqueName = (1 << 21), kFBFlagNotSelectableNameSpace = (1 << 22), kFBFlagNamespaceEditable = (1 << 23),
  kFBFlagCustomObject = (1 << 24)
}
 

Available flags for any component.

More...
enum   FBObjectStatus {
  kFBStatusNone = 0, kFBStatusCreating = (1 << 0), kFBStatusStoring = (1 << 1), kFBStatusRetrieving = (1 << 2),
  kFBStatusMerging = (1 << 3), kFBStatusDestroying = (1 << 4), kFBStatusOwnedByUndo = (1 << 5)
}
 

Available lifetime status for any component.

More...
enum   FBNamespaceAction { kFBConcatNamespace, kFBReplaceNamespace, kFBRemoveAllNamespace }
 

Namespace flags.

More...

Functions
  K_FORWARD (IRegister)
  K_FORWARD (IError)
  K_FORWARD (IStore)
  K_FORWARD (IKtView)
  K_FORWARD (KEventBase)
  K_FORWARD (KGlobalNamedEvent)
FBSDK_DLL int  __FBRegisterTypeInfo (int pInternalClassId)
  __FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.
FBSDK_DLL int  __FBGetInternalClassId (int pTypeInfo)
  __FBGetInternalClassId For internal use only, Get the internal class Id from the ORSDK FBCompoent's TypeInfo.
FBSDK_DLL FBPlug *  __FBObjectCreatorSub (HIObject pObject)
  __FBObjectCreatorSub For internal use only, Create the FBPlug object from internal object.
FBSDK_DLL void  __FBAddModelToScene (HIObject pObject)
  For internal usage only.
FBSDK_DLL void  __FBRemoveModelFromScene (HIObject pObject)
  For internal usage only.
  __FB_FORWARD (FBComponent)
  __FB_FORWARD (FBVisualComponent)
FBSDK_DLL FBComponent *  GetFBComponent (const HIObject Object)
  Get a handle to the FBComponent belonging to an HIObject.
FBSDK_DLL FBVisualComponent *  FBGetFBVisualComponent (HIKtView pObject, bool pAutoCreate=true)
  Get the FBComponent from an Internal Object.
FBSDK_DLL FBComponent *  FBGetFBComponent (HIObject pObject, bool pAutoCreate=true)
  Get the FBComponent from an Internal Object.
FBSDK_DLL FBPlug *  FBGetFBPlug (HIObject pObject, bool pAutoCreate=true)
  Get the FBPlug from an Internal Object.
FBSDK_DLL FBArrayTemplate
< FBComponent * > & 		 FBGetComponentArray ()
  Get the Root FBComponent.
FBSDK_DLL void  FBSetStoreableCustomModelRegistered ()
FBSDK_DLL bool  FBGetStoreableCustomModelRegistered ()
FBSDK_DLL void  FBSetStoreableCustomMaterialRegistered ()
FBSDK_DLL bool  FBGetStoreableCustomMaterialRegistered ()
FBSDK_DLL bool  FBObject_Register (const char *pGroupName, const char *pEntryName, const char *pDescription, kObjectCreatorFnc pCreatorFnc, bool pIsMultipleAllowed, const char *pIconFilename)
FBSDK_DLL bool  FBObject_Unregister (const char *pGroupName, const char *pEntryName, int nth=0)
FBSDK_DLL FBComponent *  FBCreateObject (const char *pGroupName, const char *pEntryName, const char *pName, void *pData=NULL, int nth=0)
  FBCreateObject.
bool  FBUnregisterObject (const char *pGroupName, const char *pEntryName, int nth=0)
  FBUnregisterObject.
FBSDK_DLL int  FBRegister_ClassId (const char *pClassName)
  FB_FORWARD (FBPropertyListComponent)
  FB_DEFINE_LIST (FBSDK_DLL, Component)
  FB_FORWARD (FBFolder)
  FB_DEFINE_COMPONENT (FBSDK_DLL, Folder)
  FB_DEFINE_ENUM (FBSDK_DLL, ConnectionType)
  FB_DEFINE_ENUM (FBSDK_DLL, ConnectionAction)
  FB_DEFINE_ENUM (FBSDK_DLL, ObjectFlag)
  FB_FORWARD (FBPropertyListObject)
  __FB_FORWARD (FBNamespace)
  __FB_FORWARD (FBEvent)
  __FB_FORWARD (FBEventConnectionNotify)
  __FB_FORWARD (FBEventConnectionDataNotify)
  __FB_FORWARD (FBEventConnectionStateNotify)
  __FB_FORWARD (FBEventConnectionKeyingNotify)
  __FB_FORWARD (FBCustomManager)

Detailed Description

Basic class definitions.

Contains the basic classes that most SDK objects will derive from. These classes form the base of many functionalities of the SDK. The file also contains the base macros used in the definition/registration of the SDK classes.

Definition in file fbcomponent.h.

Define Documentation

#define FBSDK_DLL   K_DLLIMPORT
Search for all occurrences

Be sure that FBSDK_DLL is defined only once...

Definition at line 57 of file fbcomponent.h.

#define FB_DEFAULT_SDK_ICON   "openreality_noicon.png"
Search for all occurrences

Define SDK icon filename.

Definition at line 89 of file fbcomponent.h.

#define __FBClassInit   mLocalPtr = NULL;
Search for all occurrences

For internal use only.

Definition at line 95 of file fbcomponent.h.

#define __FBClassInitSDKComponent (   pObjectToWrappedIsAllocated )
Search for all occurrences
Value: 
__FBClassInit; \
    mSDKComponent = pObjectToWrappedIsAllocated;

For internal use onlyL decide if we need to delete the corresponding KObject.

Definition at line 101 of file fbcomponent.h.

#define __FBClassImplementation (   ThisComponent,
  pInternalClassId 
)
Search for all occurrences
Value: 
int ThisComponent::TypeInfo=__FBRegisterTypeInfo(pInternalClassId);\
        int ThisComponent::GetInternalClassId() { return pInternalClassId; }

For internal use only.

Definition at line 109 of file fbcomponent.h.

#define __FBClassImplementationGroup (   ThisComponent,
  pInternalClass 
)
Search for all occurrences
Value: 
__FBClassImplementation( ThisComponent,pInternalClass::ClassId )\
        const char* ThisComponent::ClassGroupName = pInternalClass::ClassGroupName;

Definition at line 113 of file fbcomponent.h.

#define __FBClassDeclare (   Name,
  Parent 
)
Search for all occurrences

Definition at line 139 of file fbcomponent.h.

#define __FBClassDeclareGroup (   Name,
  Parent 
)
Search for all occurrences
Value: 
__FBClassDeclare( Name,Parent )\
  public:\
    static  const char* ClassGroupName; \\
  private:

For internal use only.

Definition at line 163 of file fbcomponent.h.

#define FBStorableClassImplementation (   ClassName,
  Type 
)
Search for all occurrences
Value: 
const char* ClassName::FbxGetObjectSubType(){ return #ClassName; }\
    HIObject RegisterStorable##ClassName##Create(HIObject /*pOwner*/, const char* pName, void* /*pData*/){\
        ClassName* Class = new ClassName(pName);\
        Class->mAllocated = true;\
        if( Class->FBCreate() ){\
            __FBRemoveModelFromScene( Class->GetHIObject() ); /* Hack in MoBu2013, we shouldn't add object to the scene/entity automatically*/\
            return Class->GetHIObject();\
        } else {\
            delete Class;\
            return NULL;}}\
    FBLibraryModule(ClassName##Storable){\
        FBString lGroup = "FbxStorable/";\
        lGroup += #Type;\
        FBRegisterObject(ClassName##R2, lGroup, #ClassName, "", RegisterStorable##ClassName##Create, true, NULL);}

Storable Class implementation.

This should be placed in the source code file for a class.

Definition at line 176 of file fbcomponent.h.

#define FBElementClassImplementation (   ClassName,
  IconFileName 
)
Search for all occurrences
Value: 
HIObject RegisterElement##ClassName##Create(HIObject /*pOwner*/, const char* pName, void* /*pData*/){\
        ClassName* Class = new ClassName(pName);\
        Class->mAllocated = true;\
        if( Class->FBCreate() ){\
            __FBRemoveModelFromScene( Class->GetHIObject() ); /* Hack in MoBu2013, we shouldn't add object to the scene/entity automatically*/\
            return Class->GetHIObject();\
        } else {\
            delete Class;\
            return NULL;}}\
    FBLibraryModule(ClassName##Element){\
        FBRegisterObject(ClassName##R2, "Browsing/Templates/Elements", #ClassName, "", RegisterElement##ClassName##Create, true, IconFileName);}

Element Class implementation.

(Asset system) This should be placed in the source code file for a class.

Definition at line 195 of file fbcomponent.h.

#define FBShadingElementClassImplementation (   ClassName,
  IconFileName 
)
Search for all occurrences
Value: 
HIObject RegisterShadingElement##ClassName##Create(HIObject /*pOwner*/, const char* pName, void* /*pData*/){\
        ClassName* Class = new ClassName(pName);\
        Class->mAllocated = true;\
        if( Class->FBCreate() ){\
            return Class->GetHIObject();\
        } else {\
            delete Class;\
            return NULL;}}\
    FBLibraryModule(ClassName##ShadingElement){\
        FBRegisterObject(ClassName##R2, "Browsing/Templates/Shading Elements", #ClassName, "", RegisterShadingElement##ClassName##Create, true, IconFileName);}

Shading Element Class implementation.

This should be placed in the source code file for a class.

Definition at line 211 of file fbcomponent.h.

#define FBStorableClassDeclare (   Name,
  Parent 
)
Search for all occurrences
Value: 
FBClassDeclare(Name, Parent);\
public:\
    virtual const char* FbxGetObjectSubType() override; \\
private: \

Storable Class declaration.

Overloads the necessary functions when a class inherits from FBComponent (or its derivatives) and that you want it to be persistent.

Parameters:
Name Name of class to declare.
Parent Parent class to associate with Name.

Definition at line 229 of file fbcomponent.h.

#define FBPropertyInitComponent (   Param,
  Type,
  PropName,
  Get,
  Set 
)
Search for all occurrences
Value: 
{ \
        PropertyAdd(PropName.Init( (void *)Param,#PropName,(Type* (*)(void *))Get,(void (*)(void *,Type*))Set )); \
        PropName.TypeInfo = &Type::TypeInfo; \
    }

Initialize a property: component.

Parameters:
Param Owner name.
Type Type of variable.
PropName Component name.
Get Get function pointer.
Set Set function pointer.

Definition at line 244 of file fbcomponent.h.

#define FBIS (   Component,
  ComponentType 
)    ((Component) && (Component)->Is( ComponentType::TypeInfo ))
Search for all occurrences

Macro to verify the type of a component.

Used to compare a component to another, by verifying their Class::TypeInfo values.

Parameters:
Component Component to verify.
ComponentType Type to verify Component with.
Returns:
true if object is of type ComponentType.

Definition at line 257 of file fbcomponent.h.

#define FBRegisterEvent   ( Object, EventId, EventProc ) IQ( Object,IRegister)->Register ( EventId,(HICallback)this,(kICallbackHandler)EventProc );
Search for all occurrences

Event registration/unregistration.

For internal use only.

Definition at line 312 of file fbcomponent.h.

#define FBUnregisterEvent   ( Object, EventId, EventProc ) IQ( Object,IRegister)->Unregister ( EventId,(HICallback)this,(kICallbackHandler)EventProc );
Search for all occurrences

Event registration/unregistration.

For internal use only.

Definition at line 317 of file fbcomponent.h.

#define FBRegisterObject (   LocalId,
  Path,
  Name,
  Description,
  Constructor,
  IsMultipleAllowed,
  IconFilename 
)    static int __R##LocalId = FBObject_Register( Path,Name,Description,Constructor,IsMultipleAllowed,IconFilename )
Search for all occurrences

Event registration/unregistration.

For internal use only.

Definition at line 355 of file fbcomponent.h.

#define FBDeclareUserObject (   ClassName )
Search for all occurrences
Value: 
public:\
    static int      ClassId;\
    virtual int     GetUserClassId();\
    virtual const char* FbxGetObjectSubType() override;\\
private:

Event registration/unregistration.

For internal use only.

Definition at line 372 of file fbcomponent.h.

#define FBLibraryDeclare (   LibName )
Search for all occurrences
Value: 
static FBLibrary LibName##GlobalFBLibrary; \
    extern "C" {    \
        K_DLLEXPORT bool LIBRARY_INIT(HIError /*Error*/) \
        { \
            FB_EXT_INIT( LibName ); if (LibName##GlobalFBLibrary.LibInit()) return true; return false; \
        } \
    } \
    FB_DLL_INIT( LibName, Operation )               \
    {                                               \
        switch( Operation )                         \
        {                                           \
            case kFBDllLoad:                        \
            {

Declare the library for the application.

Creates the FBLibrary object and generic interface functions for DLL access.

Definition at line 1089 of file fbcomponent.h.

#define FBLibraryModule (   Name )    void FBModule##Name()
Search for all occurrences

FBLibraryModule Define a module registration call.

Parameters:
Name Module to register.

Definition at line 1109 of file fbcomponent.h.

#define FBLibraryRegister (   ClassName )
Search for all occurrences
Value: 
extern void FBModule##ClassName( );         \
    FBModule##ClassName( );

FBLibraryRegister Declare the module's registration functions.

Parameters:
ClassName Class to declare registration functions for.

Definition at line 1116 of file fbcomponent.h.

#define FBLibraryRegisterStorable (   ClassName )
Search for all occurrences
Value: 
extern void FBModule##ClassName##Storable( );           \
    FBModule##ClassName##Storable( );

FBLibraryRegisterStorable Declare the module's registration functions for storable classes.

Parameters:
ClassName Class to declare registration functions for.

Definition at line 1124 of file fbcomponent.h.

#define FBLibraryRegisterElement (   ClassName )
Search for all occurrences
Value: 
extern void FBModule##ClassName##Element( );            \
    FBModule##ClassName##Element( );

FBLibraryRegisterElement Declare the module's registration functions for element classes.

Parameters:
ClassName Class to declare registration functions for.

Definition at line 1132 of file fbcomponent.h.

#define FBLibraryRegisterShadingElement (   ClassName )
Search for all occurrences
Value: 
extern void FBModule##ClassName##ShadingElement( );         \
    FBModule##ClassName##ShadingElement( );

FBLibraryRegisterShadingElement Declare the module's registration functions for shading element classes.

Parameters:
ClassName Class to declare registration functions for.

Definition at line 1140 of file fbcomponent.h.

#define FBLibraryDeclareEnd
Search for all occurrences
Value: 
}                                       \
        break;                                  \
        default:                                \
        break;                                  \
    }                                           \
}

Finish library declaration.

Definition at line 1145 of file fbcomponent.h.

#define FBCustomManagerImplementation (   ThisComponent )    FBClassImplementation( ThisComponent ) \
Search for all occurrences

FBCustomManagerImplementation.

Parameters:
ThisComponent Component to customize

Definition at line 1158 of file fbcomponent.h.

#define FBRegisterCustomManager (   ClassName )
Search for all occurrences
Value: 
FBLibraryModule( ClassName )                        \
    {                                                   \
        static ClassName g##ClassName;                  \
        g##ClassName.FBCreate();                        \
        g##ClassName.RegisterManager();                 \
    }                                                   \

FBRegisterCustomManager.

Parameters:
ClassName Class to declare registration functions for.

Definition at line 1164 of file fbcomponent.h.

#define FBCustomManagerDeclare (   ClassName )
Search for all occurrences
Value: 
FBClassDeclare( ClassName, FBCustomManager );           \
    public:                                             \
    ClassName() : FBCustomManager() { FBClassInit; }    \             \
    private:

FBRegisterCustomDeclare.

Parameters:
ClassName Class to declare registration functions for.

Definition at line 1175 of file fbcomponent.h.

Typedef Documentation

typedef FBArrayTemplate<FBComponent*> FBComponentList
Search for all occurrences

typedef FBArrayTemplate<FBComponent*> FBComponentList;

Definition at line 299 of file fbcomponent.h.

typedef HIRegister HISender
Search for all occurrences

HISender.

Definition at line 358 of file fbcomponent.h.

typedef HKEventBase HKEvent
Search for all occurrences

HKEvent.

Definition at line 360 of file fbcomponent.h.

typedef void(ICallback::* FBCallback)(HISender pSender, HKEvent pEvent)
Search for all occurrences

FBCallback.

Parameters:
pSender Set the sender
pEvent Set the event

Definition at line 365 of file fbcomponent.h.

typedef FBComponent FBObject
Search for all occurrences

Equivalent to FBComponent for gradual transition.

Definition at line 842 of file fbcomponent.h.

Enumeration Type Documentation

enum FBObjectFlag
Search for all occurrences

Available flags for any component.

Enumerator:
kFBFlagSelectable 

Can be selected.

Search for all occurrences
kFBFlagDeletable 

Can be deleted.

Search for all occurrences
kFBFlagSavable 

Can be saved.

Search for all occurrences
kFBFlagVisible 

Can be visible.

Search for all occurrences
kFBFlagClonable 

Can be cloned.

Search for all occurrences
kFBFlagSystem 

Created from System (not from user)

Search for all occurrences
kFBFlagNewable 

Deleted on File->New.

Search for all occurrences
kFBFlagRenamable 

Can be renamed.

Search for all occurrences
kFBFlagMergeable 

Can be merged.

Search for all occurrences
kFBFlagBrowsable 

Visible in the Scene Navigator/Schematic View/Property View/Model View.

Search for all occurrences
kFBFlagParentable 

Object (model) can be "parented".

Used by the apply manager contextual menu.

Search for all occurrences
kFBFlagDetachable 

Object can be "detached".

Used by the apply manager contextual menu.

Search for all occurrences
kFBFlagUndoable 

Object can undo its actions and states, in a global Undo Stack.

Search for all occurrences
kFBFlagUndoableSeparately 

Object which has kFlagUndoableSeparately flag turned on will have a separate Undo Stack.

Search for all occurrences
kFBFlagKeyable 

Object can Key his property.

(System Camera can't)

Search for all occurrences
kFBFlagAllocated 

Object is allocated, so it must call 'delete this' on destroy.

Search for all occurrences
kFBFlagStory 

Object created/used by the Story tool.

Useful flag for filtering Story objects.

Search for all occurrences
kFBFlagStorable6 

System/Obsolete.

Search for all occurrences
kFBFlagStorableData6 

System/Obsolete.

Search for all occurrences
kFBFlagStorableBlindData 

Used in FBX SDK native IO.

Search for all occurrences
kFBFlagStorableBlindDataForceBinary 
Search for all occurrences
kFBFlagUniqueName 

< Used in FBX SDK native IO, force bindary format for the bindary data.

Object unique name can be added to the unique name list (at first, only RootNode have this flag)

Search for all occurrences
kFBFlagNotSelectableNameSpace 

The entity will not add the namespace of the object to his list of all the namespaces of the scene.

Search for all occurrences
kFBFlagNamespaceEditable 

Allow editting on the namespace objects.

Search for all occurrences
kFBFlagCustomObject 

User custom class instances.

Search for all occurrences

Definition at line 402 of file fbcomponent.h.

{
    kFBFlagSelectable = (1 << 0),           
    kFBFlagDeletable = (1 << 1),            
    kFBFlagSavable = (1 << 2),              
    kFBFlagVisible = (1 << 3),              
    kFBFlagClonable = (1 << 4),             
    kFBFlagSystem = (1 << 5),               
    kFBFlagNewable = (1 << 6),              
    kFBFlagRenamable = (1 << 7),            
    kFBFlagMergeable = (1 << 8),            
    kFBFlagBrowsable = (1 << 9),            
    kFBFlagParentable           = (1 << 10),    
    kFBFlagDetachable           = (1 << 11),    
    kFBFlagUndoable             = (1 << 12),
enum FBObjectStatus
Search for all occurrences

Available lifetime status for any component.

Enumerator:
kFBStatusNone 

No special status, default value.

Search for all occurrences
kFBStatusCreating 

Object is in creation operations.

Search for all occurrences
kFBStatusStoring 

Object is in storing operations.

Search for all occurrences
kFBStatusRetrieving 

Object is in retrieving operations.

Search for all occurrences
kFBStatusMerging 

Object is in Merging operations.

Search for all occurrences
kFBStatusDestroying 

Object is in destruction operations.

Search for all occurrences
kFBStatusOwnedByUndo 

Object is owned by undo framework.

Search for all occurrences

Definition at line 432 of file fbcomponent.h.

                    {
enum FBNamespaceAction
Search for all occurrences

Namespace flags.

Enumerator:
kFBConcatNamespace 

Use to add a namespace name to object.

Search for all occurrences
kFBReplaceNamespace 

Use to replace a define namespace.

Search for all occurrences
kFBRemoveAllNamespace 

Remove all the namespace name.

Search for all occurrences

Definition at line 443 of file fbcomponent.h.

                    {
    kFBStatusNone       = 0,        
    kFBStatusCreating   = (1 << 0), 
    kFBStatusStoring    = (1 << 1),

Function Documentation

K_FORWARD ( IRegister  )
Search for all occurrences
K_FORWARD ( IError  )
Search for all occurrences
K_FORWARD ( IStore  )
Search for all occurrences
K_FORWARD ( IKtView  )
Search for all occurrences
K_FORWARD ( KEventBase  )
Search for all occurrences
K_FORWARD ( KGlobalNamedEvent  )
Search for all occurrences
FBSDK_DLL int __FBRegisterTypeInfo ( int  pInternalClassId )
Search for all occurrences

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

FBSDK_DLL int __FBGetInternalClassId ( int  pTypeInfo )
Search for all occurrences

__FBGetInternalClassId For internal use only, Get the internal class Id from the ORSDK FBCompoent's TypeInfo.

FBSDK_DLL FBPlug* __FBObjectCreatorSub ( HIObject  pObject )
Search for all occurrences

__FBObjectCreatorSub For internal use only, Create the FBPlug object from internal object.

FBSDK_DLL void __FBAddModelToScene ( HIObject  pObject )
Search for all occurrences

For internal usage only.

FBSDK_DLL void __FBRemoveModelFromScene ( HIObject  pObject )
Search for all occurrences

For internal usage only.

__FB_FORWARD ( FBComponent  )
Search for all occurrences
__FB_FORWARD ( FBVisualComponent  )
Search for all occurrences
FBSDK_DLL FBComponent* GetFBComponent ( const HIObject  Object )
Search for all occurrences

Get a handle to the FBComponent belonging to an HIObject.

This will not create the internal SDK object, and will return NULL if the SDK object has not been initialized.

Parameters:
Object Internal object for which the FBComponent is required.
Returns:
Handle to FBComponent belonging to Object.
FBSDK_DLL FBVisualComponent* FBGetFBVisualComponent ( HIKtView  pObject,
bool  pAutoCreate = true 
)
Search for all occurrences

Get the FBComponent from an Internal Object.

Parameters:
pObject Object to get SDK object for.
pAutoCreate Create object if it doesn't exist? (default is true)
Returns:
FBComponent for pObject.
FBSDK_DLL FBComponent* FBGetFBComponent ( HIObject  pObject,
bool  pAutoCreate = true 
)
Search for all occurrences

Get the FBComponent from an Internal Object.

Parameters:
pObject Object to get SDK object for.
pAutoCreate Create object if it doesn't exist? (default is true)
Returns:
FBComponent for pObject.
FBSDK_DLL FBPlug* FBGetFBPlug ( HIObject  pObject,
bool  pAutoCreate = true 
)
Search for all occurrences

Get the FBPlug from an Internal Object.

Parameters:
pObject Object to get SDK object for.
pAutoCreate Create object if it doesn't exist? (default is true)
Returns:
FBComponent for pObject.
FBSDK_DLL FBArrayTemplate<FBComponent*>& FBGetComponentArray ( )
Search for all occurrences

Get the Root FBComponent.

FBSDK_DLL void FBSetStoreableCustomModelRegistered ( )
Search for all occurrences
FBSDK_DLL bool FBGetStoreableCustomModelRegistered ( )
Search for all occurrences
FBSDK_DLL void FBSetStoreableCustomMaterialRegistered ( )
Search for all occurrences
FBSDK_DLL bool FBGetStoreableCustomMaterialRegistered ( )
Search for all occurrences
FBSDK_DLL bool FBObject_Register ( const char *  pGroupName,
const char *  pEntryName,
const char *  pDescription,
kObjectCreatorFnc  pCreatorFnc,
bool  pIsMultipleAllowed,
const char *  pIconFilename 
)
Search for all occurrences
FBSDK_DLL bool FBObject_Unregister ( const char *  pGroupName,
const char *  pEntryName,
int  nth = 0 
)
Search for all occurrences
FBSDK_DLL FBComponent* FBCreateObject ( const char *  pGroupName,
const char *  pEntryName,
const char *  pName,
void *  pData = NULL,
int  nth = 0 
)
Search for all occurrences

FBCreateObject.

Parameters:
pGroupName Set the name of the Group.
pEntryName Set the name of the Entry.
pName Set the name of the Object to create.
pData Data to pass to object creator function.
nth Set the occurence of the object to remove.
bool FBUnregisterObject ( const char *  pGroupName,
const char *  pEntryName,
int  nth = 0 
) [inline]
Search for all occurrences

FBUnregisterObject.

Parameters:
pGroupName Set the Name of the Group from which unregister an object.
pEntryName Set the name of the Object to unregister.
nth Set the occurence of the object to remove.

Definition at line 350 of file fbcomponent.h.

{ return FBObject_Unregister( pGroupName,pEntryName,nth ); }
FBSDK_DLL int FBRegister_ClassId ( const char *  pClassName )
Search for all occurrences
FB_FORWARD ( FBPropertyListComponent  )
Search for all occurrences
FB_DEFINE_LIST ( FBSDK_DLL  ,
Component   
)
Search for all occurrences
FB_FORWARD ( FBFolder  )
Search for all occurrences
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
Folder   
)
Search for all occurrences
FB_DEFINE_ENUM ( FBSDK_DLL  ,
ConnectionType   
)
Search for all occurrences
FB_DEFINE_ENUM ( FBSDK_DLL  ,
ConnectionAction   
)
Search for all occurrences
FB_DEFINE_ENUM ( FBSDK_DLL  ,
ObjectFlag   
)
Search for all occurrences
FB_FORWARD ( FBPropertyListObject  )
Search for all occurrences
__FB_FORWARD ( FBNamespace  )
Search for all occurrences
__FB_FORWARD ( FBEvent  )
Search for all occurrences
__FB_FORWARD ( FBEventConnectionNotify  )
Search for all occurrences
__FB_FORWARD ( FBEventConnectionDataNotify  )
Search for all occurrences
__FB_FORWARD ( FBEventConnectionStateNotify  )
Search for all occurrences
__FB_FORWARD ( FBEventConnectionKeyingNotify  )
Search for all occurrences
__FB_FORWARD ( FBCustomManager  )
Search for all occurrences
Generated on Sun Mar 18 2012 08:58:45 by doxygen 1.7.3
Please send us your comment about this page