Model marker class. More...

#include <fbmodel.h>

Inheritance diagram for FBModelMarker:

[legend]

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) override
	Store and Retrieve function that can be overloaded.

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override
	Request additional Unique color IDs.

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', 'FBModelMarker'.

Public Member Functions inherited from FBModel
	FBModel (const char *pName, HIObject pObject=NULL)
	Constructor.

virtual void	FBDelete () override
	Open Reality deletion function.

	IQuery_Declare (override)
	Interface to IObject.

	ICallback_Declare (override)
	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	GetLocalTransformationMatrixWithGlobalRotationDoF (FBMatrix &pMatrix, bool pInverse=false, FBEvaluateInfo *pEvaluateInfo=NULL)
	Get the local transformation (or local inverse transformation) matrix with the global Rotation DoF values 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.

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.

bool	RayCast (FBCamera *pCamera, int pMouseX, int pMouseY, FBVector3d &pHitPosition, FBVector3d &pHitNormal)
	Ray cast test.

void	SetMatrixWithPrecision (FBMatrix pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=true, bool pPushUndo=false, FBEvaluateInfo *pEvaluateInfo=NULL, double pPrecision=FBMat2EulerDegenerateForPrecision10)
	Set a matrix for the model.

unsigned int	GetHierarchyWorldMatrices (FBMatrix pMatricesArray, unsigned int pMatricesArrayCount, FBModelHiercharyTraverserType pHiercharyTraverserType, FBEvaluateInfo pEvaluateInfo=NULL)
	Computes the global transform matrices between this model and all its children (all levels).

void	CollapseInSchematic ()
	Collapse the model in the schematic view.

void	ExpandInSchematic ()
	Expand the model in the schematic view.

bool	IsCollapsedInSchematic () const
	Returns if the model is collapsed or not (expanded) in the schematic view.

virtual bool	ManipulatorNotify (FBSelectionAction pAction)
	Callback for component selection in custom FBModel.

Public Member Functions inherited from FBBox
	FBBox (const char *pName, HIObject pObject=NULL)
	Constructor.

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 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	ResolveCandidate (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Function is call when candidate needs to be resolved (like global to local).

virtual ECandidateAction	SetGlobalCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a global candidate is set on an animation node.

virtual ECandidateAction	SetStdCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a non-global candidate is set on an animation node.

virtual bool	FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
	Storage/Retrieval of information into the FBX file format.

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)

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.

virtual FBAnimationNode *	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box.

virtual FBAnimationNode *	AnimationNodeOutGet ()

virtual const char *	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.

virtual const char *	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.

	IObject_Declare (override)

virtual int	GetOutConnectorCount () const
	Get the number of animation node outputs for this box.

virtual int	GetInConnectorCount () const
	Get the number of animation node inputs for this box.

virtual FBAnimationNode *	GetOutConnector (int pIndex) const
	Get the animation node output associated with the given index.

virtual FBAnimationNode *	GetInConnector (int pIndex) const
	Get the animation node input associated with the given index.

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager.

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager.

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager.

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId.

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

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.

Public Attributes inherited from FBModel
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. Not Savable

FBPropertyBool	BlendShapeDeformable
	Read Write Property: Model blend-shape deformable. Not Savable

FBPropertyBool	ConstrainDeformable
	Read Write Property: Model constraint deformable. Not Savable

FBPropertyBool	PointCacheDeformable
	Read Write Property: Model point cache deformable. Not Savable

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. This can be overridden by the 'Show' property.

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. This has a default value of 'false'.

FBPropertyBool	Pickable
	Read Write Property: Indicate if a model can be picked in the viewer. This has a default value of 'true'.

FBPropertyBool	Transformable
	Read Write Property: Indicate if a model can be transformable in the viewer. This has a default value of 'true'.

FBPropertyColor	UniqueColorId
	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	PrimaryVisibility
	Read Write Property: Control the geometry render state. Geometry can still cast shadows even if this is turned off.

FBPropertyBool	CastsShadows
	Read Write Property: If true, the geometry will produce shadows.

FBPropertyBool	ReceiveShadows
	Read Write Property: If true, the geometry will receive shadows.

Public Attributes inherited from FBBox
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?

Public Attributes inherited from FBComponent
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.

Additional Inherited Members
Public Types inherited from FBBox
enum	ECandidateAction { eCandidateAccept , eCandidateIntercept , eCandidateInterceptAfterEvaluation }
	Resolving action for candidates. More...

Static Public Member Functions inherited from FBComponent
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 Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.

Protected Member Functions inherited from FBPlug
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 const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

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.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

Model marker class.

Definition at line 872 of file fbmodel.h.

Constructor & Destructor Documentation

◆ FBModelMarker()

FBModelMarker	(	const char *	pName,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters

pName	Name of model marker. If pObject is not NULL, pName will be ignored.
pObject	For internal use only (default=NULL).

Member Function Documentation

◆ FbxGetObjectSubType()

virtual const char * FbxGetObjectSubType ( )

overridevirtual

Returns the class sub type inherited by the class of an object, for example: 'Default', 'Mesh', 'FBModelMarker'.

Returns: The class sub type inherited by the class of an object.

Reimplemented from FBModel.

◆ FbxGetObjectType()

virtual const char * FbxGetObjectType ( )

overridevirtual

Returns the class type inherited by the class of an object, for example: 'Model'.

Returns: The class type inherited by the class of an object.

Reimplemented from FBModel.

◆ FbxRetrieve()

virtual bool FbxRetrieve	(	FBFbxObject *	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)

overridevirtual

Request additional Unique color IDs.

Parameters

pCount User should note that Unique Color ID resource is limited (only 24 bits), hence should avoid to use unnecessary large number.

Returns: True if Unique ColorId resource is available.

Reimplemented from FBModel.

◆ FbxStore()

virtual bool FbxStore	(	FBFbxObject *	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)

overridevirtual

Store and Retrieve function that can be overloaded.

Parameters

pFbxObject	FBX Object that is used to communicate I/O operations.
pStoreWhat	Which attributes are currently stored/retrieved.

Reimplemented from FBModel.

◆ SetFKOpacity()

void SetFKOpacity ( double pValue )

Used when shading the controlset.

Parameters

pValue Value between 0 and 100. Normally the controlset opacity value is used.

Member Data Documentation

◆ Color

FBPropertyColor Color

Read Write Property: Color of model marker.

Definition at line 886 of file fbmodel.h.

◆ IKPivot

FBPropertyVector3d IKPivot

Read Write Property: marker Pivot Offset.

Definition at line 887 of file fbmodel.h.

◆ IKSync

FBPropertyBool IKSync

Read Write Property: Must sync with IK if true.

Definition at line 888 of file fbmodel.h.

◆ Length

FBPropertyDouble Length

Read Write Property: Length for capsule (not related to scaling).

Definition at line 882 of file fbmodel.h.

◆ Look

FBPropertyMarkerLook Look

Read Write Property: Look of model marker.

Definition at line 884 of file fbmodel.h.

◆ ResLevel

FBPropertyMarkerResolutionLevel ResLevel

Read Write Property: Resolution level of model marker.

Definition at line 883 of file fbmodel.h.

◆ Size

FBPropertyDouble Size

Read Write Property: Size (not related to scaling).

Definition at line 881 of file fbmodel.h.

◆ Type

FBPropertyMarkerType Type

Read Write Property: Type of model marker.

Definition at line 885 of file fbmodel.h.

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

fbmodel.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBModelMarker()

Member Function Documentation

◆ FbxGetObjectSubType()

◆ FbxGetObjectType()

◆ FbxRetrieve()

◆ FbxStore()

◆ SetFKOpacity()

Member Data Documentation

◆ Color

◆ IKPivot

◆ IKSync

◆ Length

◆ Look

◆ ResLevel

◆ Size

◆ Type