Python Reference Guide
 
Loading...
Searching...
No Matches
FBModelPath3D Class Reference

Path 3D model class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBModelPath3D:

Public Member Functions

 FBModelPath3D (str pName)
 Constructor.
 
float ConvertSegmentPercentToTotalPercent (float pPercent, FBEvaluateInfo pEvaluateInfo=None)
 Converting one key type Segment (time) to Total (percent).
 
float ConvertToSegmentPercentFactor ()
 Get factor for multiplying the derivative of a key for segment mode.
 
float ConvertToTotalPercentFactor ()
 Get factor for multiplying the derivative of a key for total mode.
 
float ConvertTotalPercentToSegmentPercent (float pPercent, FBEvaluateInfo pEvaluateInfo=None)
 Converting one key type Total (percent) to Segment (time).
 
int GetSelectedPathKeyCount ()
 Query the number of keys present in the selected path.
 
int InsertNewEndKey ()
 Insert a new key at the end of the path.
 
int InsertNewStartKey ()
 Insert a new key at the start of the path.
 
 PathKeyClear ()
 Clear the path keys.
 
int PathKeyEndAdd (FBVector4d pTLocal)
 Adds a new key to the end of the path (with time gap of 1 sec).
 
FBVector4d PathKeyGet (int pKeyIndex)
 Get path's key vector for at a particular key index.
 
FBModel PathKeyGetControlNode (int pKeyIndex)
 Get the path key's control node.
 
int PathKeyGetCount ()
 Query the number of keys present in the path.
 
FBVector4d PathKeyGetLeftTangent (int pKeyIndex)
 Get the path key left tangent's vector value for designated index.
 
float PathKeyGetLeftTangentLength (int pKeyIndex)
 Query the length of the left tangent.
 
FBProperty PathKeyGetProperty (int pKeyIndex)
 Get the path key's corresponding property.
 
FBVector4d PathKeyGetRightTangent (int pKeyIndex)
 Get the path key right tangent's vector value for designated index.
 
float PathKeyGetRightTangentLength (int pKeyIndex)
 Query the value of the right tangent.
 
FBVector4d PathKeyGetXYZDerivative (int pKeyIndex)
 Get vector in XYZ coordinates for a path tangent.
 
int PathKeyInsertAfter (int pKeyIndex, FBVector4d pTLocal)
 Adds a new key immediately after the specified key ID (with time gap of 1 sec).
 
 PathKeyRemove (int pKeyIndex)
 Remove key at a particular index.
 
 PathKeyRemoveSelected ()
 Remove the selected keys from the path.
 
 PathKeySet (int pKeyIndex, FBVector4d pTLocal, bool pUpdate=True)
 Set the local coordinate vector values for path at a particular key index.
 
bool PathKeySetControlNode (int pKeyIndex, FBModel pControlNode)
 Set the path key's control node.
 
 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.
 
 PathKeySetLeftTangent (int pKeyIndex, FBVector4d pTLocal, bool pUpdate=True)
 Set path's key left tangent vector for designated index.
 
 PathKeySetRightTangent (int pKeyIndex, FBVector4d pTLocal, bool pUpdate=True)
 Set 3D path's key right tangent vector for designated index.
 
 PathKeySetXDerivative (int pKeyIndex, float pDerivative, bool pUpdate)
 Set derivative in X coordinate for a path tangent.
 
 PathKeySetXYZDerivative (int pKeyIndex, FBVector4d pDerivative, bool pUpdate)
 Set derivative in XYZ coordinates for a path tangent.
 
 PathKeySetYDerivative (int pKeyIndex, float pDerivative, bool pUpdate)
 Set derivative in Y coordinate for a path tangent.
 
 PathKeySetZDerivative (int pKeyIndex, float pDerivative, bool pUpdate)
 Set derivative in Z coordinate for a path tangent.
 
int PathKeyStartAdd (FBVector4d pTLocal)
 Adds a new key to the start of the path (with time gap of 1 sec).
 
FBVector4d Segment_GlobalPathEvaluate (float pSegmentPercent, FBEvaluateInfo pEvaluateInfo=None)
 Get the path's vector at a particular point within the curve, in global coordinates.
 
FBVector4d Segment_GlobalPathEvaluateDerivative (float pSegmentPercent, FBEvaluateInfo pEvaluateInfo=None)
 Get the path's derivative at a particular point within the curve, in global coordinates.
 
int Segment_IsPathKey (float pSegmentPercent, FBEvaluateInfo pEvaluateInfo=None)
 Query whether a percentage value has a key associated at that point in the path.
 
FBVector4d Segment_LocalPathEvaluate (float pSegmentPercent, FBEvaluateInfo pEvaluateInfo=None)
 Get the path's vector at a particular point within the curve, in local coordinates.
 
FBVector4d Segment_LocalPathEvaluateDerivative (float pSegmentPercent, FBEvaluateInfo pEvaluateInfo=None)
 Get the path's derivative at a particular point within the curve, in local coordinates.
 
 ShowCurveControls (bool pShow)
 Enable or disable displaying Curve Controls for the 3D model path.
 
 ShowCurvePoints (bool pShow)
 Enable or disable displaying Curve Points for the 3D model path.
 
FBVector4d Total_GlobalPathEvaluate (float pTotalPercent, FBEvaluateInfo pEvaluateInfo=None)
 Get the path's vector at a particular point within the curve, in global coordinates.
 
FBVector4d Total_GlobalPathEvaluateDerivative (float pTotalPercent, FBEvaluateInfo pEvaluateInfo=None)
 Get the path's derivative at a particular point within the curve, in global coordinates.
 
int Total_IsPathKey (float pTotalPercent, FBEvaluateInfo pEvaluateInfo=None)
 Query whether a percentage value has a key associated at that point in the path.
 
FBVector4d Total_LocalPathEvaluate (float pTotalPercent, FBEvaluateInfo pEvaluateInfo=None)
 Get the path's vector at a particular point within the curve, in local coordinates.
 
FBVector4d Total_LocalPathEvaluateDerivative (float pTotalPercent, FBEvaluateInfo pEvaluateInfo=None)
 Get the path's derivative at a particular point within the curve, in local coordinates.
 
 UpdateGeometry ()
 Update path geometry explicitly.
 
- Public Member Functions inherited from FBModel
 FBModel (str pName)
 Constructor.
 
FBModel Clone ()
 Clone the model.
 
 CollapseInSchematic ()
 Collapse the model in the schematic view.
 
 DofToLRM (FBMatrix pLM, FBRVector pDof)
 Convert object space vector to local matrix.
 
 ExpandInSchematic ()
 Expand the model in the schematic view.
 
 FBDelete ()
 Open Reality deletion function.
 
str FbxGetObjectSubType ()
 Returns the class sub type inherited by the class of an object, for example: 'Default', 'Mesh'.
 
str FbxGetObjectType ()
 Returns the class type inherited by the class of an object, for example: 'Model'.
 
 ForceAlwaysEvaluate ()
 Force Always Evaluate.
 
FBColor GetAdditionalUniqueColorID (unsigned int pIndex)
 Get Additional Unique Color Id.
 
unsigned int GetAdditionalUniqueColorIDCount ()
 Get additional unique color count.
 
 GetBoundingBox (FBVector3d pMin, FBVector3d pMax)
 Get the bounding box of the model.
 
unsigned int GetHierarchyWorldMatrices (FBMatrix pMatricesArray, unsigned int pMatricesArrayCount, FBModelHiercharyTraverserType pHiercharyTraverserType, FBEvaluateInfo pEvaluateInfo=None)
 Computes the global transform matrices between this model and all its children (all levels).
 
 GetLocalTransformationMatrixWithGlobalRotationDoF (FBMatrix pMatrix, bool pInverse=False, FBEvaluateInfo pEvaluateInfo=None)
 Get the local transformation (or local inverse transformation) matrix with the global Rotation DoF values from the model.
 
 GetMatrix (FBMatrix pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=True, FBEvaluateInfo pEvaluateInfo=None)
 Get a matrix from the model.
 
FBVector2d GetSchematicPosition ()
 Get the position in the schematic view for the model.
 
int GetSelectedPointsCount ()
 Get the number of selected points in the model.
 
 GetVector (FBVector3d pVector, FBModelTransformationType pWhat=kModelTranslation, bool pGlobalInfo=True, FBEvaluateInfo pEvaluateInfo=None)
 Get a vector from the model.
 
bool IsCollapsedInSchematic ()
 Returns if the model is collapsed or not (expanded) in the schematic view.
 
bool IsEvaluationReady (FBModelEvaluationTaskType pWhat, FBEvaluateInfo pEvaluateInfo=None)
 Is the model's evaluation task result ready.
 
bool IsForceAlwaysEvaluate ()
 Return Force Always Evaluate status.
 
bool IsVisible (FBEvaluateInfo pEvaluateInfo=None)
 If the model is visible.
 
 LRMToDof (FBRVector pDof, FBMatrix pLM)
 Convert local matrix to object space vector.
 
 MatrixToRotation (FBRVector pRotation, FBMatrix pMatrix)
 Convert Rotation Matrix to Euler Vector based on model's rotation order.
 
int NoFrustumCullingRelease ()
 Release no frustum culling request.
 
int NoFrustumCullingRequire ()
 Acquire no frustum culling request.
 
bool RayCast (FBCamera pCamera, int pMouseX, int pMouseY, FBVector3d pHitPosition, FBVector3d pHitNormal)
 Ray cast test.
 
 RotationToMatrix (FBMatrix pMatrix, FBRVector pRotation)
 Convert Euler Vector to Rotation Matrix based on model's rotation order.
 
bool SetAdditionalUniqueColorIDCount (unsigned int pCount)
 Request additional Unique color IDs.
 
 SetMatrix (FBMatrix pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=True, bool pPushUndo=False, FBEvaluateInfo pEvaluateInfo=None)
 Set a matrix for the model.
 
 SetMatrixWithPrecision (FBMatrix pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=True, bool pPushUndo=False, FBEvaluateInfo pEvaluateInfo=None, float pPrecision=FBMat2EulerDegenerateForPrecision10)
 Set a matrix for the model.
 
 SetSchematicPosition (int pX, int pY)
 Set the position in the schematic view for the model.
 
 SetSchematicPosition (FBVector2d pVector2d)
 Set the position in the schematic view for the model.
 
 SetVector (FBVector3d pVector, FBModelTransformationType pWhat=kModelTranslation, bool pGlobalInfo=True, bool pPushUndo=False, FBEvaluateInfo pEvaluateInfo=None)
 Set a vector for the model.
 
 SetupPropertiesForShapes ()
 Setup Shape Properties.
 
bool UseFrustumCulling ()
 Get the current Frustum Culling Status.
 
- Public Member Functions inherited from FBBox
 FBBox (str pName)
 Constructor.
 
bool AnimationNodeDestroy (FBAnimationNode pAnimationNode)
 Destroy an animation node.
 
FBAnimationNode AnimationNodeInGet ()
 Get the (IN/OUT) animation node for this box.
 
bool AnimationNodeIsUserData (FBAnimationNode pAnimationNode)
 Is the animation node user data?
 
FBAnimationNode AnimationNodeOutGet ()
 
str FbxGetObjectSubType ()
 Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.
 
str FbxGetObjectType ()
 Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.
 
FBAnimationNode GetInConnector (int pIndex)
 Get the animation node input associated with the given index.
 
int GetInConnectorCount ()
 Get the number of animation node inputs for this box.
 
FBAnimationNode GetOutConnector (int pIndex)
 Get the animation node output associated with the given index.
 
int GetOutConnectorCount ()
 Get the number of animation node outputs for this box.
 
- Public Member Functions inherited from FBComponent
 FBComponent ()
 Constructor.
 
str ClassName ()
 Get the class name.
 
 DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags.
 
 EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags.
 
bool FBCreate ()
 Open Reality Creation function.
 
 FBDelete ()
 Open Reality deletion function.
 
 FBDestroy ()
 Open Reality destruction function.
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated).
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled.
 
FBFileReference GetOwnerFileReference (p0)
 Get the owner FileReference object.
 
 HardSelect ()
 HardSelect.
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled.
 
bool Is (int pTypeId)
 Returns true if object is of type TypeId.
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessNamespaceHierarchy.
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessObjectNamespace.
 
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.
 
FBProperty PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
 Create user or dynamic property.
 
 PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading.
 
 PropertyRemove (FBProperty pProperty)
 Remove a Property from the component's Property manager.
 
 SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags.
 
 SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status.
 

Public Attributes

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

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

 
KeyBehavior KeyPropertyBehavior
 Read Only Property: Key property behavior.

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

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

 
float PathLength
 Read Only Property: Path Length In Centimeter.

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

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

 
UnitType PathLengthUnit
 Read Write Property: Path Length Unit.

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

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

 
- Public Attributes inherited from FBModel
FBAnimationNode AnimationNode
 Read Only Property: Animation node of the model.

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

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

 
FBListModel Children
 List: Children for model.

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

 
FBListDeformer Deformers
 List: Deformers (Skeleton Deformer or Point Cache Deformer).

 
FBVector3d GeometricRotation
 Read Write Property: Geometric rotation.

 
FBVector3d GeometricScaling
 Read Write Property: Geometric scaling.

 
FBVector3d GeometricTranslation
 Read Write Property: Geometric translation.

 
FBGeometry Geometry
 Read Write Property: Geometry for the model.

 
int GeometryUpdateId
 Read Only Property: model geometry (vertex data) related update id.

 
bool Icon3D
 Read Write Property: Is model a 3D icon?

 
bool IsConstrained
 Read Only Property: Is model constrained?

 
bool IsDeformable
 Read Only Property: Is model deformable?

 
FBModel LookAt
 Read Write Property: Look at model (interest point).

 
FBListMaterial Materials
 List: Materials for model.

 
FBModelVertexData ModelVertexData
 Read Only Property: ModelVertexData for the model.

 
FBModel Parent
 Read Write Property: Parent model.

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

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

 
bool PointCacheRecord
 Read Write Property: Record Point Cache for model? Not Savable

 
FBVector3d PostRotation
 Read Write Property: Post Rotation (considered if RotationActive is true)

 
FBVector3d PreRotation
 Read Write Property: Pre Rotation (considered if RotationActive is true)

 
bool PrimaryVisibility
 Read Write Property: Control the geometry render state. Geometry can still cast shadows even if this is turned off.

 
bool QuaternionInterpolate
 Read Write Property: Use quaternion interpolation.

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

 
FBAnimatableVector3d Rotation
 Read Write Property: Lcl rotation.

 
bool RotationActive
 Read Write Property: Is model using Rotation Limits?

 
FBVector3d RotationMax
 Read Write Property: Max Rotation Limit (considered if RotationActive is true)

 
bool RotationMaxX
 Read Write Property: Is model using Maximum Rotation Limits On X?

 
bool RotationMaxY
 Read Write Property: Is model using Maximum Rotation Limits On Y?

 
bool RotationMaxZ
 Read Write Property: Is model using Maximum Rotation Limits On Z?

 
FBVector3d RotationMin
 Read Write Property: Min Rotation Limit (considered if RotationActive is true)

 
bool RotationMinX
 Read Write Property: Is model using Minimum Rotation Limits On X?

 
bool RotationMinY
 Read Write Property: Is model using Minimum Rotation Limits On Y?

 
bool RotationMinZ
 Read Write Property: Is model using Minimum Rotation Limits On Z?

 
FBModelRotationOrder RotationOrder
 Read Write Property: Rotation order.

 
bool RotationSpaceForLimitOnly
 Read Write Property: Apply Post Rotation Matrix only for Limits?

 
FBAnimatableVector3d Scaling
 Read Write Property: Lcl scaling.

 
FBScene Scene
 Read Only Property: Scene containing the model.

 
FBListShader Shaders
 List: Shaders for model.

 
FBModelShadingMode ShadingMode
 Read Write Property: Shading mode for the model.

 
bool Show
 Read Write Property: Indicate if the viewer should show the object, according to its visibility value. This has a default value of 'false'.

 
bool SkeletonDeformable
 Read Write Property: Model skeleton deformable. Not Savable

 
bool SoftSelected
 Read Write Property: Is model Soft selected?

 
FBListTexture Textures
 List: Textures with Special UseType (Other than "Color" which should connect to materials).

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

 
FBAnimatableVector3d Translation
 Read Write Property: Lcl translation.

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

 
FBModel UpVector
 Read Write Property: UpVector model.

 
FBAnimatableBool Visibility
 Read Write Property: Visibility of model. This can be overridden by the 'Show' property.

 
bool VisibilityInheritance
 Read Write Property: //!< When this value is set to True the Visibility of this model is also applied to all its descendants

 
- Public Attributes inherited from FBBox
bool Animatable
 Read Write Property: Is the box animatable.

 
bool Live
 Read Write Property: Is live?

 
bool RecordMode
 Read Write Property: Is recording?

 
str UniqueName
 internal Unique name.

 
- Public Attributes inherited from FBComponent
FBListComponent Components
 List: List of components.

 
str LongName
 Read Write Property: Name and namespace for object.

 
str Name
 Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
 
FBListComponent Parents
 List: Parents.

 
FBManager PropertyList
 Read Only Property: Manages all of the properties for the component.

 
bool Selected
 Read Write Property: Selected property.

 
int TypeInfo
 Contains the Type information of the object.

 
- Public Attributes inherited from FBPlug
str ClassGroupName
 ClassGroupName of the object.

 
int TypeInfo
 TypeInfo.

 

Detailed Description

Path 3D model class.


Constructor & Destructor Documentation

◆ FBModelPath3D()

FBModelPath3D ( str  pName)

Constructor.

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))
bool Show
Read Write Property: Indicate if the viewer should show the object, according to its visibility value...
Definition: pyfbsdk_generated.h:11309
Path 3D model class.
Definition: pyfbsdk_generated.h:11605
Python module pyfbsk.
Definition: pyfbsdk.h:90
Parameters
pNameName of Path 3D.

Member Function Documentation

◆ ConvertSegmentPercentToTotalPercent()

float ConvertSegmentPercentToTotalPercent ( float  pPercent,
FBEvaluateInfo  pEvaluateInfo = None 
)

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

Parameters
pPercentDouble value (as time)
Returns
Double value which represents the corresponding percentage

◆ ConvertToSegmentPercentFactor()

float ConvertToSegmentPercentFactor ( )

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

Returns
Returns the derivative multiplication factor

◆ ConvertTotalPercentToSegmentPercent()

float ConvertTotalPercentToSegmentPercent ( float  pPercent,
FBEvaluateInfo  pEvaluateInfo = None 
)

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

Parameters
pPercentDouble value (as percentage)
Returns
Double value which represents the corresponding time.

◆ ConvertToTotalPercentFactor()

float 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()

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
pTLocalVector 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
pKeyIndexKey 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
pKeyIndexKey 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
pKeyIndexKey ID at which left tangent value is required
Returns
Vector containing value of left tangent

◆ PathKeyGetLeftTangentLength()

float PathKeyGetLeftTangentLength ( int  pKeyIndex)

Query the length of the left tangent.

Parameters
pKeyIndexKey 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
pKeyIndexKey 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
pKeyIndexKey ID to set with
Returns
Vector containing value of left tangent

◆ PathKeyGetRightTangentLength()

float PathKeyGetRightTangentLength ( int  pKeyIndex)

Query the value of the right tangent.

Parameters
pKeyIndexKey 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
pKeyIndexKey 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
pKeyIndexKey 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.
pTLocalVector value for the new added Key
Returns
Returns the newly inserted key ID.

◆ PathKeyRemove()

PathKeyRemove ( int  pKeyIndex)

Remove key at a particular index.

Parameters
pKeyIndexKey ID at which key is to be removed.

◆ PathKeyRemoveSelected()

PathKeyRemoveSelected ( )

Remove the selected keys from the path.

◆ PathKeySet()

PathKeySet ( int  pKeyIndex,
FBVector4d  pTLocal,
bool  pUpdate = True 
)

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

Parameters
pKeyIndexKey ID to set with
pTLocalVector to use to set values to Key
pUpdatetrue 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
pKeyIndexKey ID to set
pControlNodeModel to set as path key's control node.
Returns
True if successful, otherwise false.

◆ PathKeySetLeftRightTangent()

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
pKeyIndexKey ID to set key for left and right tangents
pKeyTLocalVector to use to set values to Key
pLeftTangentTLocalVector to use to set values to Key Left Tangent
pRightTangentTLocalVector to use to set values to Key Right Tangent
pUpdatetrue if geometry update is required, false if not required (default=true)

◆ PathKeySetLeftTangent()

PathKeySetLeftTangent ( int  pKeyIndex,
FBVector4d  pTLocal,
bool  pUpdate = True 
)

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

Parameters
pKeyIndexKey ID at which left tangent is to be set
pTLocalVector to use to set values to Key
pUpdatetrue if geometry update is required, false if not required (default=true)

◆ PathKeySetRightTangent()

PathKeySetRightTangent ( int  pKeyIndex,
FBVector4d  pTLocal,
bool  pUpdate = True 
)

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

Parameters
pKeyIndexKey ID at which right tangent is to be set
pTLocalVector to use to set values to Key
pUpdatetrue if geometry update is required, false if not required (default=true)

◆ PathKeySetXDerivative()

PathKeySetXDerivative ( int  pKeyIndex,
float  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
pKeyIndexKey ID to set with
pDerivativeValue of the derivative to apply to tangent
pUpdatetrue if geometry update is required, false if not required (default=true)

◆ PathKeySetXYZDerivative()

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
pKeyIndexKey ID to set with
pDerivativeValue of the derivative to apply to tangent
pUpdatetrue if geometry update is required, false if not required (default=true)

◆ PathKeySetYDerivative()

PathKeySetYDerivative ( int  pKeyIndex,
float  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
pKeyIndexKey ID to set with
pDerivativeValue of the derivative to apply to tangent
pUpdatetrue if geometry update is required, false if not required (default=true)

◆ PathKeySetZDerivative()

PathKeySetZDerivative ( int  pKeyIndex,
float  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
pKeyIndexKey ID to set with
pDerivativeValue of the derivative to apply to tangent
pUpdatetrue 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
pTLocalVector 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 ( float  pSegmentPercent,
FBEvaluateInfo  pEvaluateInfo = None 
)

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

Parameters
pSegmentPercentDouble 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 ( float  pSegmentPercent,
FBEvaluateInfo  pEvaluateInfo = None 
)

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

Parameters
pSegmentPercentDouble 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 ( float  pSegmentPercent,
FBEvaluateInfo  pEvaluateInfo = None 
)

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

Parameters
pSegmentPercentDouble 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 ( float  pSegmentPercent,
FBEvaluateInfo  pEvaluateInfo = None 
)

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

Parameters
pSegmentPercentDouble 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 ( float  pSegmentPercent,
FBEvaluateInfo  pEvaluateInfo = None 
)

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

Parameters
pSegmentPercentDouble value (as time) at which the path derivative would be computed
Returns
Vector value at the required point in the path

◆ ShowCurveControls()

ShowCurveControls ( bool  pShow)

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

Parameters
pShowtrue if curve controls are to be displayed false if not required

◆ ShowCurvePoints()

ShowCurvePoints ( bool  pShow)

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

Parameters
pShowtrue if curve points are to be displayed false if not required

◆ Total_GlobalPathEvaluate()

FBVector4d Total_GlobalPathEvaluate ( float  pTotalPercent,
FBEvaluateInfo  pEvaluateInfo = None 
)

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

Parameters
pTotalPercentDouble 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 ( float  pTotalPercent,
FBEvaluateInfo  pEvaluateInfo = None 
)

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

Parameters
pTotalPercentDouble 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 ( float  pTotalPercent,
FBEvaluateInfo  pEvaluateInfo = None 
)

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

Parameters
pTotalPercentDouble 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 ( float  pTotalPercent,
FBEvaluateInfo  pEvaluateInfo = None 
)

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

Parameters
pTotalPercentDouble 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 ( float  pTotalPercent,
FBEvaluateInfo  pEvaluateInfo = None 
)

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

Parameters
pTotalPercentDouble value (as percentage) at which the path derivative would be computed
Returns
Derivative value at the required point in the path

◆ UpdateGeometry()

UpdateGeometry ( )

Update path geometry explicitly.

Member Data Documentation

◆ AutoControlNode

bool AutoControlNode

Read Write Property: Automatically create key control nodes.

◆ Color

FBAnimatableColor Color

Read Write Property: Path display color in viewport.

◆ KeyPropertyBehavior

KeyBehavior KeyPropertyBehavior

Read Only Property: Key property behavior.

◆ PathEndCapScale

float PathEndCapScale

Read Write Property: Path end cap display scale.

◆ PathEndCapStyle

PathEndCapStyle PathEndCapStyle

Read Write Property: Path end cap display style.

◆ PathLength

float PathLength

Read Only Property: Path Length In Centimeter.

◆ PathLengthInString

str PathLengthInString

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

◆ PathLengthShow

bool PathLengthShow

Read Write Property: Path length label display or not.

◆ PathLengthUnit

UnitType PathLengthUnit

Read Write Property: Path Length Unit.

◆ TextBackground

FBColorAndAlpha TextBackground

Read Write Property: Path Length label display background color.

◆ TextScale

float TextScale

Read Write Property: Path Length label display scale.