fbsdk/fbcharactersolver.h File Reference

fbcharactersolver.h File Reference

Classes

class  FBCharacterSolver
 Constraint class. More...
 

Namespaces

 ORSDK2018
 

Macros

#define FBSDK_DLL   K_DLLIMPORT
 Be sure that FBSDK_DLL is defined only once... More...
 
#define FBRegisterCharacterSolver(UniqueNameStr, ClassName, Label, Description, IconFilename)
 Register the constraint. More...
 
#define FBCharacterSolverDeclare(ClassName, Parent)
 Constraint class declaration. More...
 
#define FBCharacterSolverImplementation(ThisComponent)   FBClassImplementation( ThisComponent )
 Constraint class implementation. More...
 

Typedefs

typedef class FBPropertyBase< FBCharacterSolver *, kFBPT_object > FBPropertyBaseCharacterSolver
 
typedef class FBPropertyBaseComponent< FBCharacterSolver * > FBPropertyCharacterSolver
 

Functions

int FBGetCharacterExternalSolverCount ()
 Get character external solver count. More...
 
const char * FBGetCharacterExternalSolverName (int pIndex)
 Get character external solver name. More...
 
int FBGetCharacterExternalSolverIndex (const char *pName)
 Get character external solver index. More...
 
FBCharacterSolver * FBInstanciateCharacterExternalSolver (int pIndex, const char *pSolverName=((void *) 0))
 Instanciate the given external character solver. More...
 

Macro Definition Documentation

#define FBCharacterSolverDeclare (   ClassName,
  Parent 
)
Value:
FBClassDeclare( ClassName, Parent ); \
public: \
ClassName(const char* pName):Parent(pName) { FBClassInit; } \
private:
#define FBClassInit
Class initialization.
Definition: fbdefines.h:64
#define FBClassDeclare(Name, Parent)
Class declaration.
Definition: fbdefines.h:85

Constraint class declaration.

Parameters
ClassNameConstraint class name.
ParentParent class name.
Warning
The class must inherit directly from FBCharacterSolver.
+ Examples:

Definition at line 99 of file fbcharactersolver.h.

#define FBCharacterSolverImplementation (   ThisComponent)    FBClassImplementation( ThisComponent )
#define FBRegisterCharacterSolver (   UniqueNameStr,
  ClassName,
  Label,
  Description,
  IconFilename 
)
Value:
HIObject RegisterCharacterSolver##ClassName##Create( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
{ \
ClassName *Class = new ClassName(pName); \
Class->UniqueName = UniqueNameStr; \
if (Class->FBCreate()) { \
return Class->GetHIObject(); \
} else { \
delete Class; \
return NULL; \
} \
} \
FBLibraryModule( ClassName ) \
{ \
FBRegisterObject( ClassName##R1,"FbxStorable/CharacterSolver",UniqueNameStr,Description,RegisterCharacterSolver##ClassName##Create, true, IconFilename ); \
FBRegisterObject( ClassName##R2,"Character/Solvers",UniqueNameStr,Description,RegisterCharacterSolver##ClassName##Create,true, IconFilename ); \
}
#define FBRegisterObject(LocalId, Path, Name, Description, Constructor, IsMultipleAllowed, IconFilename)
Event registration/un-registration.
Definition: fbcomponent.h:387
#define NULL
Definition: kaydara.h:169
#define FBLibraryModule(Name)
FBLibraryModule Define a module registration call.
Definition: fbcomponent.h:1211

Register the constraint.

Parameters
UniqueNameStrUnique name.
ClassNameName of the constraint class.
LabelShort description of constraint.
DescriptionLong description of constraint.
IconFilenameFilename of associated icon.
+ Examples:

Definition at line 75 of file fbcharactersolver.h.

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 50 of file fbcharactersolver.h.

Go to the source code of this file.