This reference page is linked to from the following overview topics: FBModel - Transformation Data and the Scene Graph, MotionBuilder 2013, Motion Capture Devices, Your First Python Program.
#include <fbmodel.h>
Public Member Functions |
|
FBModelMarker (const char *pName, HIObject pObject=NULL) | |
Constructor. |
|
void | SetFKOpacity (double pValue) |
Used when shading the controlset. |
|
virtual bool | FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) |
Store and Retrieve function that can be
overloaded. |
|
virtual bool | FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) |
virtual const char * | FbxGetObjectType () override |
Returns the class type inherited by the
class of an object, for example: 'Model'. |
|
virtual const char * | FbxGetObjectSubType () override |
Returns the class sub type inherited by the
class of an object, for example: 'Default', 'Mesh'. |
|
virtual void | FBDelete () |
Open Reality deletion function. |
|
IQuery_Declare (K_IMPLEMENTATION) | |
Interface to IObject. |
|
ICallback_Declare (K_IMPLEMENTATION) | |
Interface to ICallback. |
|
virtual FBModel * | Clone () |
Clone the model. |
|
void | SetMatrix (FBMatrix pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=true, bool pPushUndo=false, FBEvaluateInfo *pEvaluateInfo=NULL) |
Set a matrix for the model. |
|
void | GetMatrix (FBMatrix &pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=true, FBEvaluateInfo *pEvaluateInfo=NULL) |
Get a matrix from the model. |
|
void | SetVector (FBVector3d pVector, FBModelTransformationType pWhat=kModelTranslation, bool pGlobalInfo=true, bool pPushUndo=false, FBEvaluateInfo *pEvaluateInfo=NULL) |
Set a vector for the model. |
|
void | GetVector (FBVector3d &pVector, FBModelTransformationType pWhat=kModelTranslation, bool pGlobalInfo=true, FBEvaluateInfo *pEvaluateInfo=NULL) |
Get a vector from the model. |
|
bool | IsEvaluationReady (FBModelEvaluationTaskType pWhat, FBEvaluateInfo *pEvaluateInfo=NULL) const |
Is the model's evaluation task result ready.
|
|
void | MatrixToRotation (FBRVector &pRotation, const FBMatrix &pMatrix) |
Convert Rotation Matrix to Euler Vector
based on model's rotation order. |
|
void | RotationToMatrix (FBMatrix &pMatrix, const FBRVector &pRotation) |
Convert Euler Vector to Rotation Matrix
based on model's rotation order. |
|
void | LRMToDof (FBRVector &pDof, const FBMatrix &pLM) |
Convert local matrix to object space vector.
|
|
void | DofToLRM (FBMatrix &pLM, const FBRVector &pDof) |
Convert object space vector to local matrix.
|
|
void | SetSchematicPosition (int pX, int pY) |
Set the position in the schematic view for
the model. |
|
void | SetSchematicPosition (FBVector2d pVector2d) |
Set the position in the schematic view for
the model. |
|
FBVector2d | GetSchematicPosition () |
Get the position in the schematic view for
the model. |
|
void | GetBoundingBox (FBVector3d &pMin, FBVector3d &pMax) |
Get the bounding box of the model. |
|
bool | IsVisible (FBEvaluateInfo *pEvaluateInfo=NULL) |
If the model is visible. |
|
FBModelCullingMode | GetCullingMode () const |
Get Model Culling Mode. |
|
void | SetCullingMode (FBModelCullingMode pCullingMode) |
Set Model Cullin Mode. |
|
void | ForceAlwaysEvaluate () |
Force Always Evaluate. |
|
bool | IsForceAlwaysEvaluate () |
Return Force Always Evaluate status.
|
|
int | NoFrustumCullingRequire () |
Acquire no frustum culling request. |
|
int | NoFrustumCullingRelease () |
Release no frustum culling request. |
|
bool | UseFrustumCulling () |
Get the current Frustum Culling Status.
|
|
virtual bool | HasCustomDisplay () |
Function to overload to handle custom
display. |
|
virtual void | CustomModelDisplay (FBCamera *pCamera, FBModelShadingMode pShadingMode, FBModelRenderPass pRenderPass, float pPickingAreaWidth, float pPickingAreaHeight) |
Custom display function, called when
HasCustomDisplay returns true;. |
|
virtual bool | CustomModelPicking (int pNbHits, unsigned int *pSelectBuffer, FBCamera *pCamera, int pMouseX, int pMouseY, FBTVector *pLocalRaySrc, FBTVector *pLocalRayDir, FBTVector *pWorldRaySrc, FBTVector *pWorldRayDir, FBMatrix *pGlobalInverseMatrix, FBTVector *pOutPickedPoint) |
Custom picking for selection, called when
HasCustomDisplay returns true;. |
|
virtual bool | ClosestRayIntersection (const FBTVector &pRayOrigin, const FBTVector &pRayEnd, FBTVector &pIntersectPos, FBNormal &pIntersectNormal) |
Determines the first intersection point's
position and normal between ray and model surface. |
|
unsigned char * | GetSelectedPoints () |
Get the list of the points selection state.
|
|
int | GetSelectedPointsCount () |
Get the number of selected points in the
model. |
|
virtual bool | EvaluateAnimationNodes (FBEvaluateInfo *pEvaluateInfo) |
Evaluation of non TRS nodes that needs to be
evaluated. |
|
virtual bool | AnimationNodeNotify (FBAnimationNode *pAnimationNode, FBEvaluateInfo *pEvaluateInfo) |
Notification function for animation thread.
|
|
virtual bool | AnimationNodeDestroy (FBAnimationNode *pAnimationNode) |
Destroy an animation node. |
|
virtual bool | AnimationNodeIsUserData (FBAnimationNode *pAnimationNode) |
Is the animation node user data? |
|
virtual void | AnimationNodesOutDisableIfNotWritten (FBEvaluateInfo *pEvaluateInfo) |
This call will disable all out animation
nodes from being pull by system (animation thread) for given
pEvaluateInfo. |
|
IObject_Declare (K_IMPLEMENTATION) | |
virtual bool | FBCreate () |
Open Reality Creation function. |
|
virtual void | FBDestroy () |
Open Reality destruction 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. |
|
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 *) |
Additional Unique Color ID
management.
|
|
To support multiple sub items per model/geo selection & picking in easy selection mode using custom rendering routines. see OpenRealitySDK/Samples/miscellaneous/marker_template for example. |
|
bool | SetAdditionalUniqueColorIDCount (unsigned int pCount) |
Request additional Unique color IDs.
|
|
unsigned int | GetAdditionalUniqueColorIDCount () const |
Get additional unique color count. |
|
FBColor | GetAdditionalUniqueColorID (unsigned int pIndex) const |
Get Additional Unique Color Id. |
|
void | SetupPropertiesForShapes () |
Setup Shape Properties. |
|
virtual FBAnimationNode * | AnimationNodeInCreate (kReference pUserId, const char *pName, const char *pDataType, bool pIsPublic=false, double *pMin=NULL, double *pMax=NULL, bool pUserData=false) |
Creation of IN/OUT Animation Nodes. |
|
virtual FBAnimationNode * | AnimationNodeOutCreate (kReference pUserId, const char *pName, const char *pDataType, bool pIsPublic=false, double *pMin=NULL, double *pMax=NULL, bool pUserData=false) |
virtual FBAnimationNode * | AnimationNodeInGet () |
Get the (IN/OUT) animation node for this
box. |
|
virtual FBAnimationNode * | AnimationNodeOutGet () |
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 |
|
FBPropertyDouble | Size |
Read Write Property: Size (not
related to scaling). |
|
FBPropertyDouble | Length |
Read Write Property: Length for
capsule (not related to scaling). |
|
FBPropertyMarkerResolutionLevel | ResLevel |
Read Write Property: Resolution level
of model marker. |
|
FBPropertyMarkerLook | Look |
Read Write Property: Look of model
marker. |
|
FBPropertyMarkerType | Type |
Read Write Property: Type of model
marker. |
|
FBPropertyColor | Color |
Read Write Property: Color of model
marker. |
|
FBPropertyVector3d | IKPivot |
Read Write Property: marker Pivot
Offset. |
|
FBPropertyBool | IKSync |
Read Write Property: Must sync with
IK if true. |
|
FBPropertyListModel | Children |
List: Children for model. |
|
FBPropertyListShader | Shaders |
List: Shaders for model. |
|
FBPropertyListMaterial | Materials |
List: Materials for model. |
|
FBPropertyListTexture | Textures |
List: Textures with Special UseType
(Other than "Color" which should connect to materials). |
|
FBPropertyListDeformer | Deformers |
List: Deformers (Skeleton Deformer or
Point Cache Deformer). |
|
FBPropertyBool | Icon3D |
Read Write Property: Is model a 3D
icon? |
|
FBPropertyBool | SoftSelected |
Read Write Property: Is model Soft
selected? |
|
FBPropertyBool | IsDeformable |
Read Only Property: Is model
deformable? |
|
FBPropertyBool | IsConstrained |
Read Only Property: Is model
constrained? |
|
FBPropertyBool | SkeletonDeformable |
Read Write Property: Model skeleton
deformable. |
|
FBPropertyBool | BlendShapeDeformable |
Read Write Property: Model
blend-shape deformable. |
|
FBPropertyBool | ConstrainDeformable |
Read Write Property: Model constraint
deformable. |
|
FBPropertyBool | PointCacheDeformable |
Read Write Property: Model point
cache deformable. |
|
FBPropertyBool | PointCacheRecord |
Read Write Property: Record Point
Cache for model? Not Savable |
|
FBPropertyModel | Parent |
Read Write Property: Parent model.
|
|
FBPropertyModel | LookAt |
Read Write Property: Look at model
(interest point). |
|
FBPropertyModel | UpVector |
Read Write Property: UpVector model.
|
|
FBPropertyGeometry | Geometry |
Read Write Property: Geometry for the
model. |
|
FBPropertyInt | GeometryUpdateId |
Read Only Property: model geometry
(vertex data) related update id. |
|
FBPropertyMesh | TessellatedMesh |
Read Only Property: Tessellated Mesh
for the model. |
|
FBPropertyModelVertexData | ModelVertexData |
Read Only Property: ModelVertexData
for the model. |
|
FBPropertyCluster | Cluster |
Read Only Property: Link Cluster for
the model. |
|
FBPropertyScene | Scene |
Read Only Property: Scene containing
the model. |
|
FBPropertyModelShadingMode | ShadingMode |
Read Write Property: Shading mode for
the model. |
|
FBPropertyAnimationNode | AnimationNode |
Read Only Property: Animation node of
the model. |
|
FBPropertyModelRotationOrder | RotationOrder |
Read Write Property: Rotation order.
|
|
FBPropertyBool | RotationSpaceForLimitOnly |
Read Write Property: Apply Post
Rotation Matrix only for Limits? |
|
FBPropertyBool | RotationActive |
Read Write Property: Is model using
Rotation Limits? |
|
FBPropertyVector3d | PreRotation |
Read Write Property: Pre Rotation
(considered if RotationActive is true) |
|
FBPropertyVector3d | PostRotation |
Read Write Property: Post Rotation
(considered if RotationActive is true) |
|
FBPropertyVector3d | RotationMin |
Read Write Property: Min Rotation
Limit (considered if RotationActive is true) |
|
FBPropertyVector3d | RotationMax |
Read Write Property: Max Rotation
Limit (considered if RotationActive is true) |
|
FBPropertyBool | RotationMinX |
Read Write Property: Is model using
Minimum Rotation Limits On X? |
|
FBPropertyBool | RotationMinY |
Read Write Property: Is model using
Minimum Rotation Limits On Y? |
|
FBPropertyBool | RotationMinZ |
Read Write Property: Is model using
Minimum Rotation Limits On Z? |
|
FBPropertyBool | RotationMaxX |
Read Write Property: Is model using
Maximum Rotation Limits On X? |
|
FBPropertyBool | RotationMaxY |
Read Write Property: Is model using
Maximum Rotation Limits On Y? |
|
FBPropertyBool | RotationMaxZ |
Read Write Property: Is model using
Maximum Rotation Limits On Z? |
|
FBPropertyBool | TranslationActive |
Read Write Property: Is model using
Translation Limits? |
|
FBPropertyVector3d | TranslationMin |
Read Write Property: Translation
Limit Min. |
|
FBPropertyVector3d | TranslationMax |
Read Write Property: Translation
Limit Max. |
|
FBPropertyBool | TranslationMinX |
Read Write Property: Is model using
Translation Limits on Min X. |
|
FBPropertyBool | TranslationMinY |
Read Write Property: Is model using
Translation Limits on Min Y. |
|
FBPropertyBool | TranslationMinZ |
Read Write Property: Is model using
Translation Limits on Min Z. |
|
FBPropertyBool | TranslationMaxX |
Read Write Property: Is model using
Translation Limits on Max X. |
|
FBPropertyBool | TranslationMaxY |
Read Write Property: Is model using
Translation Limits on Max Y. |
|
FBPropertyBool | TranslationMaxZ |
Read Write Property: Is model using
Translation Limits on Max Z. |
|
FBPropertyAnimatableBool | Visibility |
Read Write Property: Visibility of
model. |
|
FBPropertyBool | VisibilityInheritance |
Read Write Property: //!< When
this value is set to True the Visibility of this model
is also applied to all its descendants |
|
FBPropertyAnimatableVector3d | Translation |
Read Write Property: Lcl translation.
|
|
FBPropertyAnimatableVector3d | Rotation |
Read Write Property: Lcl rotation.
|
|
FBPropertyAnimatableVector3d | Scaling |
Read Write Property: Lcl scaling.
|
|
FBPropertyVector3d | GeometricTranslation |
Read Write Property: Geometric
translation. |
|
FBPropertyVector3d | GeometricRotation |
Read Write Property: Geometric
rotation. |
|
FBPropertyVector3d | GeometricScaling |
Read Write Property: Geometric
scaling. |
|
FBPropertyBool | QuaternionInterpolate |
Read Write Property: Use quaternion
interpolation. |
|
FBPropertyBool | Show |
Read Write Property: Indicate if the
viewer should show the object, according to its visibility value.
|
|
FBPropertyBool | Pickable |
Read Write Property: Indicate if a
model can be picked in the viewer. |
|
FBPropertyBool | Transformable |
Read Write Property: Indicate if a
model can be transformable in the viewer. |
|
FBPropertyColor | UniqueColorId |
Read Only Property: Unique Color Id
for color based viewer picking. |
|
FBPropertyBool | PrimaryVisibility |
Read Write Property: Control the
geometry render state. |
|
FBPropertyBool | CastsShadows |
Read Write Property: If true, the
geometry will produce shadows. |
|
FBPropertyBool | ReceiveShadows |
Read Write Property: If true, the
geometry will receive shadows. |
|
const char * | UniqueName |
internal Unique name. |
|
FBPropertyBool | Animatable |
Read Write Property: Is the box
animatable. |
|
FBPropertyBool | Live |
Read Write Property: Is live?
|
|
FBPropertyBool | RecordMode |
Read Write Property: Is recording?
|
|
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. |
|
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. |
FBModelMarker::FBModelMarker | ( | const char * | pName, |
HIObject | pObject =
NULL |
||
) |
Constructor.
pName | Name of model marker. If pObject is not NULL, pName will be ignored. |
pObject | For internal use only (default=NULL). |
void FBModelMarker::SetFKOpacity | ( | double | pValue | ) |
Used when shading the controlset.
pValue | Value between 0 and 100. Normally the controlset opacity value is used. |
virtual bool FBModelMarker::FbxStore | ( | FBFbxObject * | pFbxObject, |
kFbxObjectStore | pStoreWhat | ||
) | [virtual] |
Store and Retrieve function that can be overloaded.
pFbxObject | FBX Object that is used to communicate I/O operations. |
pStoreWhat | Which attributes are currently stored/retrieved. |
Reimplemented from FBModel.
virtual bool FBModelMarker::FbxRetrieve | ( | FBFbxObject * | pFbxObject, |
kFbxObjectStore | pStoreWhat | ||
) | [virtual] |
Reimplemented from FBModel.
virtual const char* FBModelMarker::FbxGetObjectType | ( | ) | [override, virtual] |
Returns the class type inherited by the class of an object, for example: 'Model'.
Reimplemented from FBModel.
virtual const char* FBModelMarker::FbxGetObjectSubType | ( | ) | [override, virtual] |
Returns the class sub type inherited by the class of an object, for example: 'Default', 'Mesh'.
Reimplemented from FBModel.
virtual void FBModel::FBDelete | ( | ) | [virtual, inherited] |
FBModel::IQuery_Declare | ( | K_IMPLEMENTATION | ) | [inherited] |
Interface to IObject.
FBModel::ICallback_Declare | ( | K_IMPLEMENTATION | ) | [inherited] |
virtual FBModel* FBModel::Clone | ( | ) | [virtual, inherited] |
Clone the model.
This will duplicate the current model.
void FBModel::SetMatrix | ( | FBMatrix | pMatrix, |
FBModelTransformationType | pWhat =
kModelTransformation , |
||
bool | pGlobalInfo =
true , |
||
bool | pPushUndo = false , |
||
FBEvaluateInfo * | pEvaluateInfo =
NULL |
||
) | [inherited] |
Set a matrix for the model.
pMatrix | Information to use to set the model's matrix. |
pWhat | Type of matrix to set (default=transformation). |
pGlobalInfo | true if it is GlobalInfo, false if Local (default=true). |
pPushUndo | true if this operation is undoable, don't push undo in non UI thread. |
pEvaluateInfo | EvaluateInfo, Take Display if none specified |
void FBModel::GetMatrix | ( | FBMatrix & | pMatrix, |
FBModelTransformationType | pWhat =
kModelTransformation , |
||
bool | pGlobalInfo =
true , |
||
FBEvaluateInfo * | pEvaluateInfo =
NULL |
||
) | [inherited] |
Get a matrix from the model.
pWhat | Type of information requested (default=transformation). |
pGlobalInfo | true if it is GlobalInfo, false if Local (default=true). |
pMatrix | Matrix to fill with requested information. |
pEvaluateInfo | EvaluateInfo, Take Display if none specified. |
void FBModel::SetVector | ( | FBVector3d | pVector, |
FBModelTransformationType | pWhat =
kModelTranslation , |
||
bool | pGlobalInfo =
true , |
||
bool | pPushUndo = false , |
||
FBEvaluateInfo * | pEvaluateInfo =
NULL |
||
) | [inherited] |
Set a vector for the model.
pVector | Vector to use to set values. |
pWhat | Type of information to set (default=translation, inverses not supported). |
pGlobalInfo | true if it is GlobalInfo, false if Local (default=true). |
pPushUndo | true if this operation is undoable, don't push undo in non UI thread. |
pEvaluateInfo | EvaluateInfo, Take Display if none specified |
void FBModel::GetVector | ( | FBVector3d & | pVector, |
FBModelTransformationType | pWhat =
kModelTranslation , |
||
bool | pGlobalInfo =
true , |
||
FBEvaluateInfo * | pEvaluateInfo =
NULL |
||
) | [inherited] |
Get a vector from the model.
pWhat | Type of information requested (default=translation, inverses not supported). |
pGlobalInfo | true if it is GlobalInfo, false if Local (default=true). |
pEvaluateInfo | EvaluateInfo, Take Display if none specified |
pVector | Vector to fill with requested values. |
bool FBModel::IsEvaluationReady | ( | FBModelEvaluationTaskType | pWhat, |
FBEvaluateInfo * | pEvaluateInfo =
NULL |
||
) | const [inherited] |
Is the model's evaluation task result ready.
pWhat | Type of evaluation task. |
pEvaluateInfo | EvaluateInfo, Take Display if none specified |
\b | true if the evaluation task result is ready in place. |
Convert Rotation Matrix to Euler Vector based on model's rotation order.
pMatrix | Matrix to convert |
pRotation | Resulting euler vector. |
Convert Euler Vector to Rotation Matrix based on model's rotation order.
pRotation | Object space rotation vector to convert |
pMatrix | Resulting rotation matrix. |
Convert local matrix to object space vector.
pLM | Local rotation matrix to convert |
pDof | Resulting object space vector. |
Convert object space vector to local matrix.
pDof | Vector to convert |
pLM | Resulting local rotation matrix. |
void FBModel::SetSchematicPosition | ( | int | pX, |
int | pY | ||
) | [inherited] |
Set the position in the schematic view for the model.
pX | X position to set. |
pY | Y position to set. |
void FBModel::SetSchematicPosition | ( | FBVector2d | pVector2d | ) | [inherited] |
Set the position in the schematic view for the model.
pVector2d | Position to set. |
FBVector2d FBModel::GetSchematicPosition | ( | ) | [inherited] |
Get the position in the schematic view for the model.
void FBModel::GetBoundingBox | ( | FBVector3d & | pMin, |
FBVector3d & | pMax | ||
) | [inherited] |
Get the bounding box of the model.
Note. for deformable model, this function will provide the approximated (larger than the smallest) bounding box for performance consideration.
pMin | Minimum value of the bounding box. |
pMax | Maximum value of the bounding box. |
bool FBModel::IsVisible | ( | FBEvaluateInfo * | pEvaluateInfo =
NULL |
) | [inherited] |
If the model is visible.
Note. this query will consider self Visibility property, plus parent node/set Visibility. The visibility of a model is affected by 4 parameters: 1. The model's own visibility 2. The model's parent's visibility (if any) 3. The visibility of the set to which model belongs (if any) 4. VisibilityInheritance of the model
pEvaluateInfo | evaluate info, |
FBModelCullingMode FBModel::GetCullingMode | ( | ) | const [inherited] |
void FBModel::SetCullingMode | ( | FBModelCullingMode | pCullingMode | ) | [inherited] |
void FBModel::ForceAlwaysEvaluate | ( | ) | [inherited] |
Force Always Evaluate.
In some case, MoBu kernel perform optimization by skipping certain evaluation tasks. This function stop skipping for this model.
bool FBModel::IsForceAlwaysEvaluate | ( | ) | [inherited] |
Return Force Always Evaluate status.
int FBModel::NoFrustumCullingRequire | ( | ) | [inherited] |
Acquire no frustum culling request.
int FBModel::NoFrustumCullingRelease | ( | ) | [inherited] |
Release no frustum culling request.
bool FBModel::UseFrustumCulling | ( | ) | [inherited] |
Get the current Frustum Culling Status.
virtual bool FBModel::HasCustomDisplay | ( | ) | [inline, virtual, inherited] |
virtual void FBModel::CustomModelDisplay | ( | FBCamera * | pCamera, |
FBModelShadingMode | pShadingMode, | ||
FBModelRenderPass | pRenderPass, | ||
float | pPickingAreaWidth, | ||
float | pPickingAreaHeight | ||
) | [inline, virtual, inherited] |
Custom display function, called when HasCustomDisplay returns true;.
pCamera | Current camera for display. |
pShadingMode | Shading mode to render see FBModelShadingMode. |
pRenderPass | Actual rendering pass, see FBModelRenderPass. |
pPickingAreaWidth | Width of picking area. |
pPickingAreaHeight | Height of picking area. |
Definition at line 515 of file fbmodel.h.
{}
virtual bool FBModel::CustomModelPicking | ( | int | pNbHits, |
unsigned int * | pSelectBuffer, | ||
FBCamera * | pCamera, | ||
int | pMouseX, | ||
int | pMouseY, | ||
FBTVector * | pLocalRaySrc, | ||
FBTVector * | pLocalRayDir, | ||
FBTVector * | pWorldRaySrc, | ||
FBTVector * | pWorldRayDir, | ||
FBMatrix * | pGlobalInverseMatrix, | ||
FBTVector * | pOutPickedPoint | ||
) | [inline, virtual, inherited] |
Custom picking for selection, called when HasCustomDisplay returns true;.
pNbHits | Number of hits. |
pSelectBuffer | OpenGL hit buffer. |
pCamera | Current camera for rendering. |
pMouseX | Mouse X position. |
pMouseY | Mouse Y position. |
pLocalRaySrc | Local picking ray source. |
pLocalRayDir | Local picking ray direction. |
pWorldRaySrc | World coordinate picking ray source. |
pWorldRayDir | World coordinate picking ray direction. |
pGlobalInverseMatrix | Inverse transformation matrix of the model. |
pOutPickedPoint | Picked position. |
Definition at line 530 of file fbmodel.h.
{ return false; }
virtual bool FBModel::ClosestRayIntersection | ( | const FBTVector & | pRayOrigin, |
const FBTVector & | pRayEnd, | ||
FBTVector & | pIntersectPos, | ||
FBNormal & | pIntersectNormal | ||
) | [virtual, inherited] |
Determines the first intersection point's position and normal between ray and model surface.
pRayOrigin | Specifies origin of the view ray. |
pRayEnd | Specifies end of the view ray. |
pIntersectPos | return the first intersection point's position; |
pIntersectNormal | return the first intersection point's normal; |
unsigned char* FBModel::GetSelectedPoints | ( | ) | [inherited] |
Get the list of the points selection state.
int FBModel::GetSelectedPointsCount | ( | ) | [inherited] |
Get the number of selected points in the model.
bool FBModel::SetAdditionalUniqueColorIDCount | ( | unsigned int | pCount | ) | [inherited] |
Request additional Unique color IDs.
pCount | User should note that Unique Color ID resource is limited (only 24 bits), hence should avoid to use unnecessary large number. |
unsigned int FBModel::GetAdditionalUniqueColorIDCount | ( | ) | const [inherited] |
Get additional unique color count.
FBColor FBModel::GetAdditionalUniqueColorID | ( | unsigned int | pIndex | ) | const [inherited] |
Get Additional Unique Color Id.
pIndex | the requested unique color id index, can't be larger than GetAdditionalColorIDCount() |
void FBModel::SetupPropertiesForShapes | ( | ) | [inherited] |
Setup Shape Properties.
Normally this function is called automatically at the next global synchronization point after the geometry has been updated. However you must call it explicitly to access the shape properties immediately after shapes adding/removing before next global synchronization point.
virtual FBAnimationNode* FBBox::AnimationNodeInCreate | ( | kReference | pUserId, |
const char * | pName, | ||
const char * | pDataType, | ||
bool | pIsPublic = false , |
||
double * | pMin = NULL , |
||
double * | pMax = NULL , |
||
bool | pUserData =
false |
||
) | [virtual, inherited] |
Creation of IN/OUT Animation Nodes.
pUserId | User-defined reference number. |
pName | Name of animation node. |
pDataType | Type of data being animated. |
pIsPublic | Determine if the animation node is published, that means whether to show it in property editor and have input / output in relation constraints editor (default is false). |
pMin | Minimum values for data (default is NULL). |
pMax | Maximum values for data (default is NULL). |
pUserData | Is this user data? False means the property is NOT animated, user cannot change the data. Especially for device, it doesn't make sense to make it animated, unless you want to record the device data. (default is false). |
Reimplemented in FBDevice.
virtual FBAnimationNode* FBBox::AnimationNodeOutCreate | ( | kReference | pUserId, |
const char * | pName, | ||
const char * | pDataType, | ||
bool | pIsPublic = false , |
||
double * | pMin = NULL , |
||
double * | pMax = NULL , |
||
bool | pUserData =
false |
||
) | [virtual, inherited] |
Reimplemented in FBDevice.
virtual bool FBBox::EvaluateAnimationNodes | ( | FBEvaluateInfo * | pEvaluateInfo | ) | [virtual, inherited] |
Evaluation of non TRS nodes that needs to be evaluated.
This function is called by the real-time engine in order to process animation information.
pEvaluateInfo | Information concerning the evaluation of the animation (time, etc.) |
virtual bool FBBox::AnimationNodeNotify | ( | FBAnimationNode * | pAnimationNode, |
FBEvaluateInfo * | pEvaluateInfo | ||
) | [virtual, inherited] |
Notification function for animation thread.
This function is called by the real-time engine in order to process animation information.
pAnimationNode | Node containing the modified information. |
pEvaluateInfo | Information concerning the evaluation of the animation (time, etc.) |
Reimplemented in FBDevice, FBDeviceOptical, and FBDeviceSync.
virtual bool FBBox::AnimationNodeDestroy | ( | FBAnimationNode * | pAnimationNode | ) | [virtual, inherited] |
Destroy an animation node.
pAnimationNode | Handle to the animation node to be destroyed. |
virtual bool FBBox::AnimationNodeIsUserData | ( | FBAnimationNode * | pAnimationNode | ) | [virtual, inherited] |
Is the animation node user data?
pAnimationNode | Handle to the animation to be queried. |
virtual void FBBox::AnimationNodesOutDisableIfNotWritten | ( | FBEvaluateInfo * | pEvaluateInfo | ) | [virtual, inherited] |
This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo.
pEvaluateInfo | Evaluation synchronization object (contains evaluation id). |
virtual FBAnimationNode* FBBox::AnimationNodeInGet | ( | ) | [virtual, inherited] |
Get the (IN/OUT) animation node for this box.
virtual FBAnimationNode* FBBox::AnimationNodeOutGet | ( | ) | [virtual, inherited] |
FBBox::IObject_Declare | ( | K_IMPLEMENTATION | ) | [inherited] |
Reimplemented from FBComponent.
Reimplemented in FBCharacter, FBCharacterFace, FBCharacterSolver, FBConstraint, FBConstraintRelation, FBDevice, and FBShader.
FBComponent::GetInternalClassId | ( | ) | [static, inherited] |
virtual bool FBComponent::FBCreate | ( | ) | [virtual, inherited] |
Open Reality Creation function.
Reimplemented in FBAssetFile, FBAssetFolder, FBCustomManager, FBConsole, FBDevice, FBManipulator, FBDeviceOptical, FBDeviceSync, FBDeviceCamera, FBDeviceOpticalLayout, and FBDeviceCameraLayout.
virtual void FBComponent::FBDestroy | ( | ) | [virtual, inherited] |
Open Reality destruction function.
Reimplemented in FBConsole, FBDevice, FBDeviceOptical, FBDeviceSync, FBDeviceCamera, and FBDeviceCameraLayout.
virtual bool FBComponent::SetHIObject | ( | HIObject | pObject, |
bool | pSDKComponent | ||
) | [override, virtual, inherited] |
virtual int FBComponent::PropertyAdd | ( | FBProperty * | pProperty | ) | [virtual, inherited] |
Add a property to the component's property manager.
pProperty | The property to add to the property manager. |
bool FBComponent::PropertyAddReferenceProperty | ( | FBProperty * | pReferenceProperty | ) | [inherited] |
Add a reference property to the component's property manager.
pReferenceProperty | The property to from an other object to add a reference to (property cannot be a custom ORSDK property). |
void FBComponent::PropertyRemove | ( | FBProperty * | pProperty | ) | [inherited] |
Remove a Property from the component's Property manager.
If the property was dynamically allocated, it is deleted.
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.
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.
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).
void FBComponent::SetObjectFlags | ( | FBObjectFlag | pFlags | ) | [inherited] |
SetObjectFlags.
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.
pFlags | Flags to check if they are present. |
void FBComponent::EnableObjectFlags | ( | FBObjectFlag | pFlags | ) | [inherited] |
void FBComponent::DisableObjectFlags | ( | FBObjectFlag | pFlags | ) | [inherited] |
void FBComponent::SetObjectStatus | ( | FBObjectStatus | pStatus, |
bool | pValue | ||
) | [inherited] |
Enable/Disable a specific Object Status.
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.
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.
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. |
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.
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. |
virtual const char* FBComponent::ClassName | ( | ) | [override, virtual, inherited] |
Get the class name.
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.
Definition at line 791 of file fbcomponent.h.
{ return true; }
const char* FBComponent::GetFullName | ( | void | ) | [inherited] |
void FBComponent::SetOwnerNamespace | ( | FBNamespace * | pOwnerNSObj | ) | [inherited] |
Set the owner Namespace object.
FBNamespace* FBComponent::GetOwnerNamespace | ( | void | ) | [inherited] |
FBFileReference* FBComponent::GetOwnerFileReference | ( | void | ) | [inherited] |
Get 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] |
virtual bool FBComponent::Is | ( | int | pTypeId | ) | [virtual, inherited] |
Returns true if object is of type TypeId.
pTypeId | TypeId to compare object to. |
Reimplemented from FBPlug.
Reimplemented in FBCustomManager.
virtual int FBComponent::GetTypeId | ( | ) | [virtual, inherited] |
GetTypeId( int pTypeId )
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.
pSrc | Source plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
bool FBPlug::ConnectDst | ( | FBPlug * | pDst, |
FBConnectionType | pConnectionType =
kFBConnectionTypeNone |
||
) | [inherited] |
Add a destination connection.
pDst | Destination plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
bool FBPlug::ConnectSrcAt | ( | int | pDst_SrcIndex, |
FBPlug * | pSrc, | ||
FBConnectionType | pConnectionType =
kFBConnectionTypeNone |
||
) | [inherited] |
Add a source connection.
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. |
bool FBPlug::ConnectDstAt | ( | int | pSrc_DstIndex, |
FBPlug * | pDst, | ||
FBConnectionType | pConnectionType =
kFBConnectionTypeNone |
||
) | [inherited] |
Add a destination connection.
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. |
bool FBPlug::DisconnectDst | ( | FBPlug * | pDst | ) | [inherited] |
Remove a destination connection.
pDst | Destination plug. |
bool FBPlug::DisconnectSrc | ( | FBPlug * | pSrc | ) | [inherited] |
Remove a source connection.
pSrc | Source plug. |
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.
pIndex | Destination plug index. |
bool FBPlug::DisconnectSrcAt | ( | int | pIndex | ) | [inherited] |
Remove a source connection at a specified index.
pIndex | Source plug index. |
bool FBPlug::ReplaceDstAt | ( | int | pIndex, |
FBPlug * | pDst | ||
) | [inherited] |
Replace a destination connection at a specified index.
pIndex | Destination plug index. |
pDst | Plug that will replace the other at index. |
bool FBPlug::ReplaceSrcAt | ( | int | pIndex, |
FBPlug * | pSrc | ||
) | [inherited] |
Replace a source connection at a specified index.
pIndex | Source plug index. |
pSrc | Plug that will replace the other at index. |
bool FBPlug::SwapSrc | ( | int | pIndexA, |
int | pIndexB | ||
) | [inherited] |
Swap source connection at index A with source connection at index B.
pIndexA | Plug index. |
pIndexB | Other plug index. |
bool FBPlug::MoveSrcAt | ( | int | pIndex, |
int | pAtIndex | ||
) | [inherited] |
Move source connection at pIndex to pAtIndex.
pIndex | Plug current index. |
pAtIndex | Plug new index. |
Move source connection pSrc to the position of pAtSrc.
pSrc | Plug. |
pAtSrc | Plug that mark where we want to insert (will insert before this one). |
int FBPlug::GetSrcCount | ( | ) | [inherited] |
FBPlug* FBPlug::GetSrc | ( | int | pIndex | ) | [inherited] |
Get a source connection's plug at specified index.
pIndex | Index of the source connection's plug. |
FBConnectionType FBPlug::GetSrcType | ( | int | pIndex | ) | [inherited] |
Get a source connection's type at specified index.
pIndex | Index of the source connection's type. |
int FBPlug::GetDstCount | ( | ) | [inherited] |
Get destination connection count.
FBPlug* FBPlug::GetDst | ( | int | pIndex | ) | [inherited] |
Get a destination connection's plug at specified index.
pIndex | Index of the destination connection's plug. |
FBConnectionType FBPlug::GetDstType | ( | int | pIndex | ) | [inherited] |
Get a destination connection's type at specified index.
pIndex | Index of the destination connection's type. |
bool FBPlug::BeginChange | ( | ) | [inherited] |
Begins a change on multiple plugs.
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.
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.
pFlag | bitwise AND of self modification flags. |
void FBPlug::SetContentModified | ( | FBPlugModificationFlag | pFlag, |
bool | pBool | ||
) | [inherited] |
Set the plug's owned property/object's modification flag.
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.
pFlag | bitwise AND of content modification flags. |
int FBPlug::GetPlugConnectionModifiedList | ( | FBPlugList & | pPlugList, |
FBPlugModificationFlag | pConnectionModificatonFlag, | ||
bool | pAddRemove | ||
) | [inherited] |
Get plug's modified src/dst property/object connection added/removed List.
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. |
bool FBPlug::RevertModification | ( | FBPlugModificationFlag | pFlag =
kFBAllModifiedMask |
) | [inherited] |
Revert the plug's modification to original status.
pFlag | the type of modification to be reverted. |
void FBPlug::SetStatusFlag | ( | FBPlugStatusFlag | pStatus, |
bool | pValue | ||
) | [inherited] |
Set the plug's status flag.
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.
pStatus | bitwise AND of self modification flags. |
FBPlug* FBPlug::GetOwner | ( | ) | [inherited] |
Get the owner of this plug.
Very useful for properties since they are plugs too.
FBPlug* FBPlug::GetOwned | ( | int | pIndex | ) | [inherited] |
Get the owned plug at specified index.
pIndex | Index of the owned plug to get. |
int FBPlug::GetOwnedCount | ( | ) | [inherited] |
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.
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. |
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.
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. |
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.
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). |
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] |
K_DLLIMPORT friend int __FBRegisterTypeInfo | ( | int | pInternalClassId | ) | [friend, inherited] |
__FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.
Read Write Property: Size (not related to scaling).
Read Write Property: Length for capsule (not related to scaling).
FBPropertyMarkerResolutionLevel FBModelMarker::ResLevel |
Read Write Property: Resolution level of model marker.
FBPropertyMarkerLook FBModelMarker::Look |
Read Write Property: Look of model marker.
FBPropertyMarkerType FBModelMarker::Type |
Read Write Property: Type of model marker.
Read Write Property: Color of model marker.
Reimplemented in FBModelMarkerOptical.
Read Write Property: marker Pivot Offset.
Read Write Property: Must sync with IK if true.
FBPropertyListModel
FBModel::Children
[inherited] |
FBPropertyListShader
FBModel::Shaders
[inherited] |
FBPropertyListMaterial
FBModel::Materials
[inherited] |
FBPropertyListTexture
FBModel::Textures
[inherited] |
List: Textures with Special UseType (Other than "Color" which should connect to materials).
FBPropertyListDeformer
FBModel::Deformers
[inherited] |
List: Deformers (Skeleton Deformer or Point Cache Deformer).
FBPropertyBool
FBModel::Icon3D
[inherited] |
Read Write Property: Is model a 3D icon?
FBPropertyBool
FBModel::SoftSelected
[inherited] |
Read Write Property: Is model Soft selected?
FBPropertyBool
FBModel::IsDeformable
[inherited] |
Read Only Property: Is model deformable?
FBPropertyBool
FBModel::IsConstrained
[inherited] |
Read Only Property: Is model constrained?
FBPropertyBool
FBModel::SkeletonDeformable
[inherited] |
Read Write Property: Model skeleton deformable.
Not Savable
FBPropertyBool
FBModel::BlendShapeDeformable
[inherited] |
Read Write Property: Model blend-shape deformable.
Not Savable
FBPropertyBool
FBModel::ConstrainDeformable
[inherited] |
Read Write Property: Model constraint deformable.
Not Savable
FBPropertyBool
FBModel::PointCacheDeformable
[inherited] |
Read Write Property: Model point cache deformable.
Not Savable
FBPropertyBool
FBModel::PointCacheRecord
[inherited] |
Read Write Property: Record Point Cache for model? Not Savable
FBPropertyModel FBModel::Parent
[inherited] |
Read Write Property: Parent model.
FBPropertyModel FBModel::LookAt
[inherited] |
Read Write Property: Look at model (interest point).
FBPropertyModel FBModel::UpVector
[inherited] |
Read Write Property: UpVector model.
FBPropertyGeometry FBModel::Geometry
[inherited] |
Read Write Property: Geometry for the model.
FBPropertyInt
FBModel::GeometryUpdateId
[inherited] |
Read Only Property: model geometry (vertex data) related update id.
FBPropertyMesh FBModel::TessellatedMesh
[inherited] |
Read Only Property: Tessellated Mesh for the model.
FBPropertyModelVertexData FBModel::ModelVertexData
[inherited] |
Read Only Property: ModelVertexData for the model.
FBPropertyCluster FBModel::Cluster
[inherited] |
Read Only Property: Link Cluster for the model.
FBPropertyScene FBModel::Scene
[inherited] |
Read Only Property: Scene containing the model.
FBPropertyModelShadingMode FBModel::ShadingMode
[inherited] |
Read Write Property: Shading mode for the model.
FBPropertyAnimationNode FBModel::AnimationNode
[inherited] |
Read Only Property: Animation node of the model.
FBPropertyModelRotationOrder FBModel::RotationOrder
[inherited] |
Read Write Property: Rotation order.
FBPropertyBool
FBModel::RotationSpaceForLimitOnly
[inherited] |
Read Write Property: Apply Post Rotation Matrix only for Limits?
FBPropertyBool
FBModel::RotationActive
[inherited] |
Read Write Property: Is model using Rotation Limits?
FBPropertyVector3d
FBModel::PreRotation
[inherited] |
Read Write Property: Pre Rotation (considered if RotationActive is true)
FBPropertyVector3d
FBModel::PostRotation
[inherited] |
Read Write Property: Post Rotation (considered if RotationActive is true)
FBPropertyVector3d
FBModel::RotationMin
[inherited] |
Read Write Property: Min Rotation Limit (considered if RotationActive is true)
FBPropertyVector3d
FBModel::RotationMax
[inherited] |
Read Write Property: Max Rotation Limit (considered if RotationActive is true)
FBPropertyBool
FBModel::RotationMinX
[inherited] |
Read Write Property: Is model using Minimum Rotation Limits On X?
FBPropertyBool
FBModel::RotationMinY
[inherited] |
Read Write Property: Is model using Minimum Rotation Limits On Y?
FBPropertyBool
FBModel::RotationMinZ
[inherited] |
Read Write Property: Is model using Minimum Rotation Limits On Z?
FBPropertyBool
FBModel::RotationMaxX
[inherited] |
Read Write Property: Is model using Maximum Rotation Limits On X?
FBPropertyBool
FBModel::RotationMaxY
[inherited] |
Read Write Property: Is model using Maximum Rotation Limits On Y?
FBPropertyBool
FBModel::RotationMaxZ
[inherited] |
Read Write Property: Is model using Maximum Rotation Limits On Z?
FBPropertyBool
FBModel::TranslationActive
[inherited] |
Read Write Property: Is model using Translation Limits?
FBPropertyVector3d
FBModel::TranslationMin
[inherited] |
Read Write Property: Translation Limit Min.
FBPropertyVector3d
FBModel::TranslationMax
[inherited] |
Read Write Property: Translation Limit Max.
FBPropertyBool
FBModel::TranslationMinX
[inherited] |
Read Write Property: Is model using Translation Limits on Min X.
FBPropertyBool
FBModel::TranslationMinY
[inherited] |
Read Write Property: Is model using Translation Limits on Min Y.
FBPropertyBool
FBModel::TranslationMinZ
[inherited] |
Read Write Property: Is model using Translation Limits on Min Z.
FBPropertyBool
FBModel::TranslationMaxX
[inherited] |
Read Write Property: Is model using Translation Limits on Max X.
FBPropertyBool
FBModel::TranslationMaxY
[inherited] |
Read Write Property: Is model using Translation Limits on Max Y.
FBPropertyBool
FBModel::TranslationMaxZ
[inherited] |
Read Write Property: Is model using Translation Limits on Max Z.
FBPropertyAnimatableBool
FBModel::Visibility
[inherited] |
Read Write Property: Visibility of model.
This can be overridden by the 'Show' property.
FBPropertyBool
FBModel::VisibilityInheritance
[inherited] |
Read Write Property: //!< When this value is set to
True
the Visibility of this model is also applied to
all its descendants
FBPropertyAnimatableVector3d
FBModel::Translation
[inherited] |
Read Write Property: Lcl translation.
FBPropertyAnimatableVector3d
FBModel::Rotation
[inherited] |
Read Write Property: Lcl rotation.
FBPropertyAnimatableVector3d
FBModel::Scaling
[inherited] |
Read Write Property: Lcl scaling.
FBPropertyVector3d
FBModel::GeometricTranslation
[inherited] |
Read Write Property: Geometric translation.
FBPropertyVector3d
FBModel::GeometricRotation
[inherited] |
Read Write Property: Geometric rotation.
FBPropertyVector3d
FBModel::GeometricScaling
[inherited] |
Read Write Property: Geometric scaling.
FBPropertyBool
FBModel::QuaternionInterpolate
[inherited] |
Read Write Property: Use quaternion interpolation.
FBPropertyBool
FBModel::Show
[inherited] |
Read Write Property: Indicate if the viewer should show the object, according to its visibility value.
This has a default value of 'false'.
FBPropertyBool
FBModel::Pickable
[inherited] |
Read Write Property: Indicate if a model can be picked in the viewer.
This has a default value of 'true'.
FBPropertyBool
FBModel::Transformable
[inherited] |
Read Write Property: Indicate if a model can be transformable in the viewer.
This has a default value of 'true'.
FBPropertyColor
FBModel::UniqueColorId
[inherited] |
Read Only Property: Unique Color Id for color based viewer picking.
Color channel values are in the range [0, 1] with 1.0/255 precision.
FBPropertyBool
FBModel::PrimaryVisibility
[inherited] |
Read Write Property: Control the geometry render state.
Geometry can still cast shadows even if this is turned off.
FBPropertyBool
FBModel::CastsShadows
[inherited] |
Read Write Property: If true, the geometry will produce shadows.
FBPropertyBool
FBModel::ReceiveShadows
[inherited] |
Read Write Property: If true, the geometry will receive shadows.
const char* FBBox::UniqueName
[inherited] |
FBPropertyBool
FBBox::Animatable
[inherited] |
Read Write Property: Is the box animatable.
FBPropertyBool
FBBox::Live
[inherited] |
FBPropertyBool
FBBox::RecordMode
[inherited] |
Read Write Property: Is recording?
DataFBComponent* FBComponent::mLocalPtr
[inherited] |
Handle on DataFBComponent.
Reimplemented in FBCustomManager.
Definition at line 650 of file fbcomponent.h.
FBString FBComponent::mName
[protected, inherited] |
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.
FBPropertyManager FBComponent::PropertyList
[inherited] |
Read Only Property: Manages all of the properties for the component.
Definition at line 838 of file fbcomponent.h.
FBPropertyListComponent
FBComponent::Components
[inherited] |
List: List of components.
Reimplemented in FBScene, and FBPropertyInspector.
Definition at line 839 of file fbcomponent.h.
FBPropertyListComponent
FBComponent::Parents
[inherited] |
FBPropertyBool
FBComponent::Selected
[inherited] |
Read Write Property: Selected property.
Definition at line 841 of file fbcomponent.h.
FBPropertyString FBComponent::Name
[inherited] |
Read Write Property: Unique name of object.
Reimplemented in FBAssetMng, FBConsoleChannel, FBTriggerGroup, FBTrigger, FBMotionClip, and FBTool.
Definition at line 842 of file fbcomponent.h.
FBPropertyString FBComponent::LongName
[inherited] |
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] |
bool FBPlug::mAllocated
[inherited] |
Contain the Allocation State of the Component.
int FBPlug::mGlobalTypeInfo
[static, protected, inherited] |
HIObject FBPlug::mObject
[protected, inherited] |
bool FBPlug::mSDKComponent
[protected, inherited] |