Path 3D model class. More...

#include <fbmodelpath3d.h>

Inheritance diagram for FBModelPath3D:

[legend]

Public Types
enum	EKeyPropertyBehavior { eLegacyVector4 , eVector }
	Key property behavior. More...

enum	ELengthUnitType { eArchitectural = 0 , eMI , eCM , eM , eKM }
	Path Length Unit enum. More...

enum	EPathEndCapStyle { eNone , eArrow }
	Path end cap style enum. More...

typedef FBPropertyBaseEnum< EKeyPropertyBehavior >	PropertyKeyPropertyBehavior

typedef FBPropertyBaseEnum< ELengthUnitType >	PropertyUnitType

typedef FBPropertyBaseEnum< EPathEndCapStyle >	PropertyPathEndCapStyle

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

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

void	ShowCurveControls (bool pShow)
	Enable or disable displaying Curve Controls for the 3D model path.

void	ShowCurvePoints (bool pShow)
	Enable or disable displaying Curve Points for the 3D model path.

int	PathKeyGetCount ()
	Query the number of keys present in the path.

FBVector4d	PathKeyGet (int pKeyIndex)
	Get path's key vector for at a particular key index.

void	PathKeySet (int pKeyIndex, FBVector4d pTLocal, bool pUpdate=true)
	Set the local coordinate vector values for path at a particular key index.

void	PathKeySetLeftRightTangent (int pKeyIndex, FBVector4d pKeyTLocal, FBVector4d pLeftTangentTLocal, FBVector4d pRightTangentTLocal, bool pUpdate=true)
	Set path's vectors for key, left tangent and right tangent at a particular key index.

void	PathKeyRemove (int pKeyIndex)
	Remove key at a particular index.

void	PathKeyClear ()
	Clear the path keys.

void	PathKeySetLeftTangent (int pKeyIndex, FBVector4d pTLocal, bool pUpdate=true)
	Set path's key left tangent vector for designated index.

void	PathKeySetRightTangent (int pKeyIndex, FBVector4d pTLocal, bool pUpdate=true)
	Set 3D path's key right tangent vector for designated index.

FBVector4d	PathKeyGetLeftTangent (int pKeyIndex)
	Get the path key left tangent's vector value for designated index.

FBVector4d	PathKeyGetRightTangent (int pKeyIndex)
	Get the path key right tangent's vector value for designated index.

void	PathKeySetXDerivative (int pKeyIndex, double pDerivative, bool pUpdate)
	Set derivative in X coordinate for a path tangent.

void	PathKeySetYDerivative (int pKeyIndex, double pDerivative, bool pUpdate)
	Set derivative in Y coordinate for a path tangent.

void	PathKeySetZDerivative (int pKeyIndex, double pDerivative, bool pUpdate)
	Set derivative in Z coordinate for a path tangent.

void	PathKeySetXYZDerivative (int pKeyIndex, FBVector4d pDerivative, bool pUpdate)
	Set derivative in XYZ coordinates for a path tangent.

FBVector4d	PathKeyGetXYZDerivative (int pKeyIndex)
	Get vector in XYZ coordinates for a path tangent.

double	PathKeyGetLeftTangentLength (int pKeyIndex)
	Query the length of the left tangent.

double	PathKeyGetRightTangentLength (int pKeyIndex)
	Query the value of the right tangent.

int	GetSelectedPathKeyCount ()
	Query the number of keys present in the selected path.

void	PathKeyRemoveSelected ()
	Remove the selected keys from the path.

int	InsertNewStartKey ()
	Insert a new key at the start of the path.

int	InsertNewEndKey ()
	Insert a new key at the end of the path.

int	PathKeyStartAdd (FBVector4d pTLocal)
	Adds a new key to the start of the path (with time gap of 1 sec).

int	PathKeyEndAdd (FBVector4d pTLocal)
	Adds a new key to the end of the path (with time gap of 1 sec).

int	PathKeyInsertAfter (int pKeyIndex, FBVector4d pTLocal)
	Adds a new key immediately after the specified key ID (with time gap of 1 sec).

FBProperty *	PathKeyGetProperty (int pKeyIndex)
	Get the path key's corresponding property.

FBModel *	PathKeyGetControlNode (int pKeyIndex)
	Get the path key's control node.

bool	PathKeySetControlNode (int pKeyIndex, FBModel *pControlNode)
	Set the path key's control node.

int	Total_IsPathKey (double pTotalPercent, FBEvaluateInfo *pEvaluateInfo=NULL)
	Query whether a percentage value has a key associated at that point in the path.

FBVector4d	Total_GlobalPathEvaluate (double pTotalPercent, FBEvaluateInfo *pEvaluateInfo=NULL)
	Get the path's vector at a particular point within the curve, in global coordinates.

FBVector4d	Total_LocalPathEvaluate (double pTotalPercent, FBEvaluateInfo *pEvaluateInfo=NULL)
	Get the path's vector at a particular point within the curve, in local coordinates.

FBVector4d	Total_GlobalPathEvaluateDerivative (double pTotalPercent, FBEvaluateInfo *pEvaluateInfo=NULL)
	Get the path's derivative at a particular point within the curve, in global coordinates.

FBVector4d	Total_LocalPathEvaluateDerivative (double pTotalPercent, FBEvaluateInfo *pEvaluateInfo=NULL)
	Get the path's derivative at a particular point within the curve, in local coordinates.

int	Segment_IsPathKey (double pSegmentPercent, FBEvaluateInfo *pEvaluateInfo=NULL)
	Query whether a percentage value has a key associated at that point in the path.

FBVector4d	Segment_GlobalPathEvaluate (double pSegmentPercent, FBEvaluateInfo *pEvaluateInfo=NULL)
	Get the path's vector at a particular point within the curve, in global coordinates.

FBVector4d	Segment_LocalPathEvaluate (double pSegmentPercent, FBEvaluateInfo *pEvaluateInfo=NULL)
	Get the path's vector at a particular point within the curve, in local coordinates.

FBVector4d	Segment_GlobalPathEvaluateDerivative (double pSegmentPercent, FBEvaluateInfo *pEvaluateInfo=NULL)
	Get the path's derivative at a particular point within the curve, in global coordinates.

FBVector4d	Segment_LocalPathEvaluateDerivative (double pSegmentPercent, FBEvaluateInfo *pEvaluateInfo=NULL)
	Get the path's derivative at a particular point within the curve, in local coordinates.

double	ConvertTotalPercentToSegmentPercent (double pPercent, FBEvaluateInfo *pEvaluateInfo=NULL)
	Converting one key type Total (percent) to Segment (time).

double	ConvertSegmentPercentToTotalPercent (double pPercent, FBEvaluateInfo *pEvaluateInfo=NULL)
	Converting one key type Segment (time) to Total (percent).

double	ConvertToSegmentPercentFactor ()
	Get factor for multiplying the derivative of a key for segment mode.

double	ConvertToTotalPercentFactor ()
	Get factor for multiplying the derivative of a key for total mode.

void	UpdateGeometry ()
	Update path geometry explicitly.

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.

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.

void	SetupPropertiesForShapes ()
	Setup Shape Properties.

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

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

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
PropertyKeyPropertyBehavior	KeyPropertyBehavior
	Read Only Property: Key property behavior.

FBPropertyBool	AutoControlNode
	Read Write Property: Automatically create key control nodes.

FBPropertyDouble	PathLength
	Read Only Property: Path Length In Centimeter.

FBPropertyString	PathLengthInString
	Read Only Property: Path Length Display String According To The Current Unit.

PropertyUnitType	PathLengthUnit
	Read Write Property: Path Length Unit.

FBPropertyBool	PathLengthShow
	Read Write Property: Path length label display or not.

FBPropertyDouble	TextScale
	Read Write Property: Path Length label display scale.

FBPropertyColorAndAlpha	TextBackground
	Read Write Property: Path Length label display background color.

PropertyPathEndCapStyle	PathEndCapStyle
	Read Write Property: Path end cap display style.

FBPropertyDouble	PathEndCapScale
	Read Write Property: Path end cap display scale.

FBPropertyAnimatableColor	Color
	Read Write Property: Path display color in viewport.

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
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

Path 3D model class.

Definition at line 63 of file fbmodelpath3d.h.

Member Typedef Documentation

◆ PropertyKeyPropertyBehavior

typedef FBPropertyBaseEnum<EKeyPropertyBehavior> PropertyKeyPropertyBehavior

Definition at line 100 of file fbmodelpath3d.h.

◆ PropertyPathEndCapStyle

typedef FBPropertyBaseEnum<EPathEndCapStyle> PropertyPathEndCapStyle

Definition at line 120 of file fbmodelpath3d.h.

◆ PropertyUnitType

typedef FBPropertyBaseEnum<ELengthUnitType> PropertyUnitType

Definition at line 111 of file fbmodelpath3d.h.

Member Enumeration Documentation

◆ EKeyPropertyBehavior

enum EKeyPropertyBehavior

Key property behavior.

Enumerator
eLegacyVector4	2014, 2015, 2016. Key property type is Vector4.
eVector	Introduced after 2016. Key property type is Vector, has improved control node behavior and support for auto control node.

Definition at line 95 of file fbmodelpath3d.h.

◆ ELengthUnitType

enum ELengthUnitType

Path Length Unit enum.

Definition at line 103 of file fbmodelpath3d.h.

◆ EPathEndCapStyle

enum EPathEndCapStyle

Path end cap style enum.

Definition at line 114 of file fbmodelpath3d.h.

Constructor & Destructor Documentation

◆ FBModelPath3D()

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

Constructor.

Parameters

pName	Name of Path 3D.
pObject	For internal use only(default=NULL).

Python sample code:

from pyfbsdk import *
 
path = FBModelPath3D("Test")
## After creation, a path always contain two default keys.
## At this point, path.PathKeyGetCount() will be 2.
path.Show = True
## Reposition the two default keys
path.PathKeySet(0,FBVector4d(0,0,50,0))
path.PathKeySet(1,FBVector4d(50,0,0,0))
## Add new keys at start and end of the path
path.PathKeyStartAdd(FBVector4d(0,0,100,0))
path.PathKeyEndAdd(FBVector4d(100,0,0,0))
## Insert keys inbetween existing keys
path.PathKeyInsertAfter(1,FBVector4d(0,25,50,0))
path.PathKeyInsertAfter(2,FBVector4d(50,25,0,0))

Member Function Documentation

◆ ConvertSegmentPercentToTotalPercent()

double ConvertSegmentPercentToTotalPercent	(	double	pPercent,
		FBEvaluateInfo *	pEvaluateInfo = `NULL`
	)

Converting one key type Segment (time) to Total (percent).

Parameters

pPercent Double value (as time)

Returns: Double value which represents the corresponding percentage

◆ ConvertToSegmentPercentFactor()

double ConvertToSegmentPercentFactor ( )

Get factor for multiplying the derivative of a key for segment mode.

Returns: Returns the derivative multiplication factor

◆ ConvertTotalPercentToSegmentPercent()

double ConvertTotalPercentToSegmentPercent	(	double	pPercent,
		FBEvaluateInfo *	pEvaluateInfo = `NULL`
	)

Converting one key type Total (percent) to Segment (time).

Parameters

pPercent Double value (as percentage)

Returns: Double value which represents the corresponding time.

◆ ConvertToTotalPercentFactor()

double ConvertToTotalPercentFactor ( )

Get factor for multiplying the derivative of a key for total mode.

Returns: Returns the time factor

◆ GetSelectedPathKeyCount()

int GetSelectedPathKeyCount ( )

Query the number of keys present in the selected path.

Returns: Returns the number of keys in the selected path

◆ InsertNewEndKey()

int InsertNewEndKey ( )

Insert a new key at the end of the path.

Returns: Returns (N) where (N+1) is the new total number of keys, and since the new key becomes the Nth key (index starts from 0). If path is invalid, returns 0.

◆ InsertNewStartKey()

int InsertNewStartKey ( )

Insert a new key at the start of the path.

Returns: Returns 0 since the new key becomes the first key. If path is invalid, returns 0.

◆ PathKeyClear()

void PathKeyClear ( )

Clear the path keys.

◆ PathKeyEndAdd()

int PathKeyEndAdd ( FBVector4d pTLocal )

Adds a new key to the end of the path (with time gap of 1 sec).

The derivative value for the new key is copied from the left tangent of the last key.

Parameters

pTLocal Vector value for the new added Key

Returns: Returns (N) where (N+1) is the new total number of keys, and since the new key becomes the Nth key (index starts from 0). If path is invalid, returns 0.

◆ PathKeyGet()

FBVector4d PathKeyGet ( int pKeyIndex )

Get path's key vector for at a particular key index.

Parameters

pKeyIndex Key ID to set with

Returns: Return the vector containing the value of the path key.

◆ PathKeyGetControlNode()

FBModel * PathKeyGetControlNode ( int pKeyIndex )

Get the path key's control node.

Only works when KeyPropertyBehavior is eVector.

Parameters

pKeyIndex Key ID to get

Returns: Path key's corresponding control node if successful, otherwise NULL.

◆ PathKeyGetCount()

int PathKeyGetCount ( )

Query the number of keys present in the path.

Returns: Number of keys present in the path

◆ PathKeyGetLeftTangent()

FBVector4d PathKeyGetLeftTangent ( int pKeyIndex )

Get the path key left tangent's vector value for designated index.

Parameters

pKeyIndex Key ID at which left tangent value is required

Returns: Vector containing value of left tangent

◆ PathKeyGetLeftTangentLength()

double PathKeyGetLeftTangentLength ( int pKeyIndex )

Query the length of the left tangent.

Parameters

pKeyIndex Key ID to set with

Returns: Double value of the length of left tangent

◆ PathKeyGetProperty()

FBProperty * PathKeyGetProperty ( int pKeyIndex )

Get the path key's corresponding property.

Only works when KeyPropertyBehavior is eVector.

Parameters

pKeyIndex Key ID to get

Returns: Path key's corresponding property if successful, otherwise NULL.

◆ PathKeyGetRightTangent()

FBVector4d PathKeyGetRightTangent ( int pKeyIndex )

Get the path key right tangent's vector value for designated index.

Parameters

pKeyIndex Key ID to set with

Returns: Vector containing value of left tangent

◆ PathKeyGetRightTangentLength()

double PathKeyGetRightTangentLength ( int pKeyIndex )

Query the value of the right tangent.

Parameters

pKeyIndex Key ID to set with

Returns: Double value of the length of right tangent

◆ PathKeyGetXYZDerivative()

FBVector4d PathKeyGetXYZDerivative ( int pKeyIndex )

Get vector in XYZ coordinates for a path tangent.

This works only if key interpolation type is CUBIC and tangent mode is User, Break or Auto.

Parameters

pKeyIndex Key ID to set with

Returns: Vector with value for path's tangent XYZ derivatives

◆ PathKeyInsertAfter()

int PathKeyInsertAfter	(	int	pKeyIndex,
		FBVector4d	pTLocal
	)

Adds a new key immediately after the specified key ID (with time gap of 1 sec).

The following keys are all shifted by 1 sec.

Parameters

pKeyIndex	Key ID to insert after. If key ID < 0 then the behavior is the same as PathKeyStartAdd. If key ID >= PathKeyGetCount-1 then the behavior is the same as PathKeyEndAdd.
pTLocal	Vector value for the new added Key

Returns: Returns the newly inserted key ID.

◆ PathKeyRemove()

void PathKeyRemove ( int pKeyIndex )

Remove key at a particular index.

Parameters

pKeyIndex Key ID at which key is to be removed.

◆ PathKeyRemoveSelected()

void PathKeyRemoveSelected ( )

Remove the selected keys from the path.

◆ PathKeySet()

void PathKeySet	(	int	pKeyIndex,
		FBVector4d	pTLocal,
		bool	pUpdate = `true`
	)

Set the local coordinate vector values for path at a particular key index.

Parameters

pKeyIndex	Key ID to set with
pTLocal	Vector to use to set values to Key
pUpdate	true if geometry update is required, false if not required (default=true)

◆ PathKeySetControlNode()

bool PathKeySetControlNode	(	int	pKeyIndex,
		FBModel *	pControlNode
	)

Set the path key's control node.

Only works when KeyPropertyBehavior is eVector and AutoControlNode is disabled.

Parameters

pKeyIndex	Key ID to set
pControlNode	Model to set as path key's control node.

Returns: True if successful, otherwise false.

◆ PathKeySetLeftRightTangent()

void PathKeySetLeftRightTangent	(	int	pKeyIndex,
		FBVector4d	pKeyTLocal,
		FBVector4d	pLeftTangentTLocal,
		FBVector4d	pRightTangentTLocal,
		bool	pUpdate = `true`
	)

Set path's vectors for key, left tangent and right tangent at a particular key index.

Parameters

pKeyIndex	Key ID to set key for left and right tangents
pKeyTLocal	Vector to use to set values to Key
pLeftTangentTLocal	Vector to use to set values to Key Left Tangent
pRightTangentTLocal	Vector to use to set values to Key Right Tangent
pUpdate	true if geometry update is required, false if not required (default=true)

◆ PathKeySetLeftTangent()

void PathKeySetLeftTangent	(	int	pKeyIndex,
		FBVector4d	pTLocal,
		bool	pUpdate = `true`
	)

Set path's key left tangent vector for designated index.

Parameters

pKeyIndex	Key ID at which left tangent is to be set
pTLocal	Vector to use to set values to Key
pUpdate	true if geometry update is required, false if not required (default=true)

◆ PathKeySetRightTangent()

void PathKeySetRightTangent	(	int	pKeyIndex,
		FBVector4d	pTLocal,
		bool	pUpdate = `true`
	)

Set 3D path's key right tangent vector for designated index.

Parameters

pKeyIndex	Key ID at which right tangent is to be set
pTLocal	Vector to use to set values to Key
pUpdate	true if geometry update is required, false if not required (default=true)

◆ PathKeySetXDerivative()

void PathKeySetXDerivative	(	int	pKeyIndex,
		double	pDerivative,
		bool	pUpdate
	)

Set derivative in X coordinate for a path tangent.

This works only if key interpolation type is CUBIC and tangent mode is User, Break or Auto.

Parameters

pKeyIndex	Key ID to set with
pDerivative	Value of the derivative to apply to tangent
pUpdate	true if geometry update is required, false if not required (default=true)

◆ PathKeySetXYZDerivative()

void PathKeySetXYZDerivative	(	int	pKeyIndex,
		FBVector4d	pDerivative,
		bool	pUpdate
	)

Set derivative in XYZ coordinates for a path tangent.

This works only if key interpolation type is CUBIC and tangent mode is User, Break or Auto.

Parameters

pKeyIndex	Key ID to set with
pDerivative	Value of the derivative to apply to tangent
pUpdate	true if geometry update is required, false if not required (default=true)

◆ PathKeySetYDerivative()

void PathKeySetYDerivative	(	int	pKeyIndex,
		double	pDerivative,
		bool	pUpdate
	)

Set derivative in Y coordinate for a path tangent.

This works only if key interpolation type is CUBIC and tangent mode is User, Break or Auto.

Parameters

pKeyIndex	Key ID to set with
pDerivative	Value of the derivative to apply to tangent
pUpdate	true if geometry update is required, false if not required (default=true)

◆ PathKeySetZDerivative()

void PathKeySetZDerivative	(	int	pKeyIndex,
		double	pDerivative,
		bool	pUpdate
	)

Set derivative in Z coordinate for a path tangent.

This works only if key interpolation type is CUBIC and tangent mode is User, Break or Auto.

Parameters

pKeyIndex	Key ID to set with
pDerivative	Value of the derivative to apply to tangent
pUpdate	true if geometry update is required, false if not required (default=true)

◆ PathKeyStartAdd()

int PathKeyStartAdd ( FBVector4d pTLocal )

Adds a new key to the start of the path (with time gap of 1 sec).

The derivative value for the new key is copied from the right tangent of the first key.

Parameters

pTLocal Vector value for the new added Key

Returns: Returns 0 since the new key becomes the first key. If path is invalid, returns 0.

◆ Segment_GlobalPathEvaluate()

FBVector4d Segment_GlobalPathEvaluate	(	double	pSegmentPercent,
		FBEvaluateInfo *	pEvaluateInfo = `NULL`
	)

Get the path's vector at a particular point within the curve, in global coordinates.

Parameters

pSegmentPercent Double value (as time) at which the path vector would be computed

Returns: Vector value at the required point in the path

◆ Segment_GlobalPathEvaluateDerivative()

FBVector4d Segment_GlobalPathEvaluateDerivative	(	double	pSegmentPercent,
		FBEvaluateInfo *	pEvaluateInfo = `NULL`
	)

Get the path's derivative at a particular point within the curve, in global coordinates.

Parameters

pSegmentPercent Double value (as time) at which the path derivative would be computed

Returns: Vector value at the required point in the path

◆ Segment_IsPathKey()

int Segment_IsPathKey	(	double	pSegmentPercent,
		FBEvaluateInfo *	pEvaluateInfo = `NULL`
	)

Query whether a percentage value has a key associated at that point in the path.

Parameters

pSegmentPercent Double value (as time) at which the path would be queried for existence of key

Returns: A valid key index in integer if key is present, otherwise -1

◆ Segment_LocalPathEvaluate()

FBVector4d Segment_LocalPathEvaluate	(	double	pSegmentPercent,
		FBEvaluateInfo *	pEvaluateInfo = `NULL`
	)

Get the path's vector at a particular point within the curve, in local coordinates.

Parameters

pSegmentPercent Double value (as time) at which the path vector would be computed

Returns: Vector value at the required point in the path

◆ Segment_LocalPathEvaluateDerivative()

FBVector4d Segment_LocalPathEvaluateDerivative	(	double	pSegmentPercent,
		FBEvaluateInfo *	pEvaluateInfo = `NULL`
	)

Get the path's derivative at a particular point within the curve, in local coordinates.

Parameters

pSegmentPercent Double value (as time) at which the path derivative would be computed

Returns: Vector value at the required point in the path

◆ ShowCurveControls()

void ShowCurveControls ( bool pShow )

Enable or disable displaying Curve Controls for the 3D model path.

Parameters

pShow true if curve controls are to be displayed false if not required

◆ ShowCurvePoints()

void ShowCurvePoints ( bool pShow )

Enable or disable displaying Curve Points for the 3D model path.

Parameters

pShow true if curve points are to be displayed false if not required

◆ Total_GlobalPathEvaluate()

FBVector4d Total_GlobalPathEvaluate	(	double	pTotalPercent,
		FBEvaluateInfo *	pEvaluateInfo = `NULL`
	)

Get the path's vector at a particular point within the curve, in global coordinates.

Parameters

pTotalPercent Double value (as percentage) at which the path vector would be computed

Returns: Vector value at the required point in the path

◆ Total_GlobalPathEvaluateDerivative()

FBVector4d Total_GlobalPathEvaluateDerivative	(	double	pTotalPercent,
		FBEvaluateInfo *	pEvaluateInfo = `NULL`
	)

Get the path's derivative at a particular point within the curve, in global coordinates.

Parameters

pTotalPercent Double value (as percentage) at which the path derivative would be computed

Returns: Derivative value at the required point in the path

◆ Total_IsPathKey()

int Total_IsPathKey	(	double	pTotalPercent,
		FBEvaluateInfo *	pEvaluateInfo = `NULL`
	)

Query whether a percentage value has a key associated at that point in the path.

Parameters

pTotalPercent Double value (as percentage) at which the path would be queried for existence of key

Returns: A valid key index in integer if key is present, otherwise -1

◆ Total_LocalPathEvaluate()

FBVector4d Total_LocalPathEvaluate	(	double	pTotalPercent,
		FBEvaluateInfo *	pEvaluateInfo = `NULL`
	)

Get the path's vector at a particular point within the curve, in local coordinates.

Parameters

pTotalPercent Double value (as percentage) at which the path vector would be computed

Returns: Vector value at the required point in the path

◆ Total_LocalPathEvaluateDerivative()

FBVector4d Total_LocalPathEvaluateDerivative	(	double	pTotalPercent,
		FBEvaluateInfo *	pEvaluateInfo = `NULL`
	)

Get the path's derivative at a particular point within the curve, in local coordinates.

Parameters

pTotalPercent Double value (as percentage) at which the path derivative would be computed

Returns: Derivative value at the required point in the path

◆ UpdateGeometry()

void UpdateGeometry ( )

Update path geometry explicitly.

Member Data Documentation

◆ AutoControlNode

FBPropertyBool AutoControlNode

Read Write Property: Automatically create key control nodes.

Definition at line 123 of file fbmodelpath3d.h.

◆ Color

FBPropertyAnimatableColor Color

Read Write Property: Path display color in viewport.

Definition at line 132 of file fbmodelpath3d.h.

◆ KeyPropertyBehavior

PropertyKeyPropertyBehavior KeyPropertyBehavior

Read Only Property: Key property behavior.

Definition at line 122 of file fbmodelpath3d.h.

◆ PathEndCapScale

FBPropertyDouble PathEndCapScale

Read Write Property: Path end cap display scale.

Definition at line 131 of file fbmodelpath3d.h.

◆ PathEndCapStyle

PropertyPathEndCapStyle PathEndCapStyle

Read Write Property: Path end cap display style.

Definition at line 130 of file fbmodelpath3d.h.

◆ PathLength

FBPropertyDouble PathLength

Read Only Property: Path Length In Centimeter.

Definition at line 124 of file fbmodelpath3d.h.

◆ PathLengthInString

FBPropertyString PathLengthInString

Read Only Property: Path Length Display String According To The Current Unit.

Definition at line 125 of file fbmodelpath3d.h.

◆ PathLengthShow

FBPropertyBool PathLengthShow

Read Write Property: Path length label display or not.

Definition at line 127 of file fbmodelpath3d.h.

◆ PathLengthUnit

PropertyUnitType PathLengthUnit

Read Write Property: Path Length Unit.

Definition at line 126 of file fbmodelpath3d.h.

◆ TextBackground

FBPropertyColorAndAlpha TextBackground

Read Write Property: Path Length label display background color.

Definition at line 129 of file fbmodelpath3d.h.

◆ TextScale

FBPropertyDouble TextScale

Read Write Property: Path Length label display scale.

Definition at line 128 of file fbmodelpath3d.h.

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

fbmodelpath3d.h

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PropertyKeyPropertyBehavior

◆ PropertyPathEndCapStyle

◆ PropertyUnitType

Member Enumeration Documentation

◆ EKeyPropertyBehavior

◆ ELengthUnitType

◆ EPathEndCapStyle

Constructor & Destructor Documentation

◆ FBModelPath3D()

Member Function Documentation

◆ ConvertSegmentPercentToTotalPercent()

◆ ConvertToSegmentPercentFactor()

◆ ConvertTotalPercentToSegmentPercent()

◆ ConvertToTotalPercentFactor()

◆ GetSelectedPathKeyCount()

◆ InsertNewEndKey()

◆ InsertNewStartKey()

◆ PathKeyClear()

◆ PathKeyEndAdd()

◆ PathKeyGet()

◆ PathKeyGetControlNode()

◆ PathKeyGetCount()

◆ PathKeyGetLeftTangent()

◆ PathKeyGetLeftTangentLength()

◆ PathKeyGetProperty()

◆ PathKeyGetRightTangent()

◆ PathKeyGetRightTangentLength()

◆ PathKeyGetXYZDerivative()

◆ PathKeyInsertAfter()

◆ PathKeyRemove()

◆ PathKeyRemoveSelected()

◆ PathKeySet()

◆ PathKeySetControlNode()

◆ PathKeySetLeftRightTangent()

◆ PathKeySetLeftTangent()

◆ PathKeySetRightTangent()

◆ PathKeySetXDerivative()

◆ PathKeySetXYZDerivative()

◆ PathKeySetYDerivative()

◆ PathKeySetZDerivative()

◆ PathKeyStartAdd()

◆ Segment_GlobalPathEvaluate()

◆ Segment_GlobalPathEvaluateDerivative()

◆ Segment_IsPathKey()

◆ Segment_LocalPathEvaluate()

◆ Segment_LocalPathEvaluateDerivative()

◆ ShowCurveControls()

◆ ShowCurvePoints()

◆ Total_GlobalPathEvaluate()

◆ Total_GlobalPathEvaluateDerivative()

◆ Total_IsPathKey()

◆ Total_LocalPathEvaluate()

◆ Total_LocalPathEvaluateDerivative()

◆ UpdateGeometry()

Member Data Documentation

◆ AutoControlNode

◆ Color

◆ KeyPropertyBehavior

◆ PathEndCapScale

◆ PathEndCapStyle

◆ PathLength

◆ PathLengthInString

◆ PathLengthShow

◆ PathLengthUnit

◆ TextBackground

◆ TextScale