#include <mobu-python-api.h>

Class Description

Path 3D model class.

Inheritance diagram for FBModelPath3D:

Public Member Functions
	__reduce__ ()

	__init__ (object arg1, str arg2)
	Constructor. More...

float	ConvertSegmentPercentToTotalPercent (FBModelPath3D arg1, object arg2, FBEvaluateInfo arg3)
	Converting one key type Segment (time) to Total (percent). More...

float	ConvertToSegmentPercentFactor (FBModelPath3D arg1)
	Get factor for multiplying the derivative of a key for segment mode. More...

float	ConvertTotalPercentToSegmentPercent (FBModelPath3D arg1, object arg2, FBEvaluateInfo arg3)
	Converting one key type Total (percent) to Segment (time). More...

float	ConvertToTotalPercentFactor (FBModelPath3D arg1)
	Get factor for multiplying the derivative of a key for total mode. More...

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

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

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

	PathKeyClear (FBModelPath3D arg1)
	Clear the path keys. More...

int	PathKeyEndAdd (FBModelPath3D arg1, FBVector4d arg2)
	Adds a new key to the end of the path (with time gap of 1 sec). More...

FBVector4d	PathKeyGet (FBModelPath3D arg1, object arg2)
	Get path's key vector for at a particular key index. More...

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

FBVector4d	PathKeyGetLeftTangent (FBModelPath3D arg1, object arg2)
	Get the path key left tangent's vector value for designated index. More...

FBVector4d	PathKeyGetRightTangent (FBModelPath3D arg1, object arg2)
	Get the path key right tangent's vector value for designated index. More...

FBVector4d	PathKeyGetXYZDerivative (FBModelPath3D arg1, object arg2)
	Get vector in XYZ coordinates for a path tangent. More...

int	PathKeyInsertAfter (FBModelPath3D arg1, object arg2, FBVector4d arg3)
	Adds a new key immediately after the specified key ID (with time gap of 1 sec). More...

	PathKeyRemove (FBModelPath3D arg1, object arg2)
	Remove key at a particular index. More...

	PathKeyRemoveSelected (FBModelPath3D arg1)
	Remove the selected keys from the path. More...

	PathKeySet (FBModelPath3D arg1, object arg2, FBVector4d arg3, object arg4)
	Set the local coordinate vector values for path at a particular key index. More...

	PathKeySetLeftTangent (FBModelPath3D arg1, object arg2, FBVector4d arg3, object arg4)
	Set path's key left tangent vector for designated index. More...

	PathKeySetRightTangent (FBModelPath3D arg1, object arg2, FBVector4d arg3, object arg4)
	Set 3D path's key right tangent vector for designated index. More...

	PathKeySetLeftRightTangent (FBModelPath3D arg1, object arg2, FBVector4d arg3, FBVector4d arg4, FBVector4d arg5, object arg6)
	Set path's vectors for key, left tangent and right tangent at a particular key index. More...

	PathKeySetXDerivative (FBModelPath3D arg1, object arg2, object arg3, object arg4)
	Set derivative in X coordinate for a path tangent. More...

	PathKeySetXYZDerivative (FBModelPath3D arg1, object arg2, FBVector4d arg3, object arg4)
	Set derivative in XYZ coordinates for a path tangent. More...

	PathKeySetYDerivative (FBModelPath3D arg1, object arg2, object arg3, object arg4)
	Set derivative in Y coordinate for a path tangent. More...

	PathKeySetZDerivative (FBModelPath3D arg1, object arg2, object arg3, object arg4)
	Set derivative in Z coordinate for a path tangent. More...

int	PathKeyStartAdd (FBModelPath3D arg1, FBVector4d arg2)
	Adds a new key to the start of the path (with time gap of 1 sec). More...

float	PathKeyGetLeftTangentLength (FBModelPath3D arg1, object arg2)
	Query the length of the left tangent. More...

float	PathKeyGetRightTangentLength (FBModelPath3D arg1, object arg2)
	Query the value of the right tangent. More...

object	PathKeyGetProperty (FBModelPath3D arg1, object arg2)
	Get the path key's corresponding property. More...

object	PathKeyGetControlNode (FBModelPath3D arg1, object arg2)
	Get the path key's control node. More...

bool	PathKeySetControlNode (FBModelPath3D arg1, object arg2, FBModel arg3)
	Set the path key's control node. More...

FBVector4d	Segment_GlobalPathEvaluate (FBModelPath3D arg1, object arg2, FBEvaluateInfo arg3)
	Get the path's vector at a particular point within the curve, in global coordinates. More...

FBVector4d	Segment_GlobalPathEvaluateDerivative (FBModelPath3D arg1, object arg2, FBEvaluateInfo arg3)
	Get the path's derivative at a particular point within the curve, in global coordinates. More...

int	Segment_IsPathKey (FBModelPath3D arg1, object arg2, FBEvaluateInfo arg3)
	Query whether a percentage value has a key associated at that point in the path. More...

FBVector4d	Segment_LocalPathEvaluate (FBModelPath3D arg1, object arg2, FBEvaluateInfo arg3)
	Get the path's vector at a particular point within the curve, in local coordinates. More...

FBVector4d	Segment_LocalPathEvaluateDerivative (FBModelPath3D arg1, object arg2, FBEvaluateInfo arg3)
	Get the path's derivative at a particular point within the curve, in local coordinates. More...

int	Segment_PathKeyAdd (FBModelPath3D arg1, object arg2, FBVector4d arg3, FBEvaluateInfo arg4)
	Adds a new key either at the start, end or along the path as per specified. More...

	ShowCurveControls (FBModelPath3D arg1, object arg2)
	Enable or disable displaying Curve Controls for the 3D model path. More...

	ShowCurvePoints (FBModelPath3D arg1, object arg2)
	Enable or disable displaying Curve Points for the 3D model path. More...

FBVector4d	Total_GlobalPathEvaluate (FBModelPath3D arg1, object arg2, FBEvaluateInfo arg3)
	Get the path's vector at a particular point within the curve, in global coordinates. More...

FBVector4d	Total_GlobalPathEvaluateDerivative (FBModelPath3D arg1, object arg2, FBEvaluateInfo arg3)
	Get the path's derivative at a particular point within the curve, in global coordinates. More...

int	Total_IsPathKey (FBModelPath3D arg1, object arg2, FBEvaluateInfo arg3)
	Query whether a percentage value has a key associated at that point in the path. More...

FBVector4d	Total_LocalPathEvaluate (FBModelPath3D arg1, object arg2, FBEvaluateInfo arg3)
	Get the path's vector at a particular point within the curve, in local coordinates. More...

FBVector4d	Total_LocalPathEvaluateDerivative (FBModelPath3D arg1, object arg2, FBEvaluateInfo arg3)
	Get the path's derivative at a particular point within the curve, in local coordinates. More...

int	Total_PathKeyAdd (FBModelPath3D arg1, object arg2, FBVector4d arg3, FBEvaluateInfo arg4)
	Adds a new key either at the start, end or along the path as per specified. More...

	UpdateGeometry (FBModelPath3D arg1)
	Update path geometry explicitly. More...

Public Member Functions inherited from FBModel
	__reduce__ ()

object	__copy__ (FBModel arg1)

FBColor	GetAdditionalUniqueColorID (FBModel arg1, int arg2)
	Get Additional Unique Color Id. More...

str	FbxGetObjectSubType (FBModel arg1)
	Returns the class sub type inherited by the class of an object, for example: 'Default', 'Mesh'. More...

	FBDelete (FBModel arg1)
	Open Reality deletion function. More...

str	FbxGetObjectType (FBModel arg1)
	Returns the class type inherited by the class of an object, for example: 'Model'. More...

object	Clone (FBModel arg1)
	Clone the model. More...

	GetBoundingBox (FBModel arg1, FBVector3d arg2, FBVector3d arg3)
	Get the bounding box of the model. More...

	GetMatrix (FBModel arg1, FBMatrix arg2, FBModelTransformationType arg3, object arg4, FBEvaluateInfo arg5)
	Get a matrix from the model. More...

list	GetHierarchyWorldMatrices (FBModel arg1, int arg2, FBModelHiercharyTraverserType arg3, FBEvaluateInfo arg4)
	Computes the global transform matrices between this model and all its children (all levels). More...

int	GetSelectedPointsCount (FBModel arg1)
	Get the number of selected points in the model. More...

	SetupPropertiesForShapes (FBModel arg1)
	Setup Shape Properties. More...

	GetVector (FBModel arg1, FBVector3d arg2, FBModelTransformationType arg3, object arg4, FBEvaluateInfo arg5)
	Get a vector from the model. More...

	SetMatrix (FBModel arg1, FBMatrix arg2, FBModelTransformationType arg3, object arg4, FBEvaluateInfo arg5)
	Set a matrix for the model. More...

	SetMatrixWithPrecision (FBModel arg1, FBMatrix arg2, FBModelTransformationType arg3, object arg4, FBEvaluateInfo arg5, object arg6)
	Set a matrix for the model. More...

	SetVector (FBModel arg1, FBVector3d arg2, FBModelTransformationType arg3, object arg4, FBEvaluateInfo arg5)
	Set a vector for the model. More...

	MatrixToRotation (FBModel arg1, FBVector3d arg2, FBMatrix arg3)
	Convert Rotation Matrix to Euler Vector based on model's rotation order. More...

	RotationToMatrix (FBModel arg1, FBMatrix arg2, FBVector3d arg3)
	Convert Euler Vector to Rotation Matrix based on model's rotation order. More...

	LRMToDof (FBModel arg1, FBVector3d arg2, FBMatrix arg3)
	Convert local matrix to object space vector. More...

	DofToLRM (FBModel arg1, FBMatrix arg2, FBVector3d arg3)
	Convert object space vector to local matrix. More...

	SetSchematicPosition (...)

FBVector2d	GetSchematicPosition (FBModel arg1)
	Get the position in the schematic view for the model. More...

	CollapseInSchematic (FBModel arg1)
	Collapse the model in the schematic view. More...

	ExpandInSchematic (FBModel arg1)
	Expand the model in the schematic view. More...

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

int	NoFrustumCullingRequire (FBModel arg1)
	Acquire no frustum culling request. More...

int	NoFrustumCullingRelease (FBModel arg1)
	Release no frustum culling request. More...

bool	UseFrustumCulling (FBModel arg1)
	Get the current Frustum Culling Status. More...

	ForceAlwaysEvaluate (FBModel arg1)
	Force Always Evaluate. More...

bool	IsForceAlwaysEvaluate (FBModel arg1)
	Return Force Always Evaluate status. More...

bool	IsEvaluationReady (FBModel arg1, FBModelEvaluationTaskType arg2, FBEvaluateInfo arg3)
	Is the model's evaluation task result ready. More...

bool	SetAdditionalUniqueColorIDCount (FBModel arg1, int arg2)
	Request additional Unique color IDs. More...

int	GetAdditionalUniqueColorIDCount (FBModel arg1)
	Get additional unique color count. More...

bool	RayCast (FBModel arg1, FBCamera arg2, object arg3, object arg4, FBVector3d arg5, FBVector3d arg6)
	Ray cast test. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBBox
	__reduce__ ()

bool	AnimationNodeDestroy (FBBox arg1, FBAnimationNode arg2)
	Destroy an animation node. More...

	__init__ (object arg1, str arg2)
	Constructor. More...

object	AnimationNodeInGet (FBBox arg1)
	Get the (IN/OUT) animation node for this box. More...

bool	AnimationNodeIsUserData (FBBox arg1, FBAnimationNode arg2)
	Is the animation node user data? More...

object	AnimationNodeOutGet (FBBox arg1)

int	GetOutConnectorCount (FBBox arg1)
	Get the number of animation node outputs for this box. More...

int	GetInConnectorCount (FBBox arg1)
	Get the number of animation node inputs for this box. More...

object	GetOutConnector (FBBox arg1, object arg2)
	Get the animation node output associated with the given index. More...

object	GetInConnector (FBBox arg1, object arg2)
	Get the animation node input associated with the given index. More...

Public Member Functions inherited from FBComponent
	__reduce__ ()

FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...

str	ClassName (FBComponent arg1)
	Get the class name. More...

	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...

	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...

bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...

	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...

	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...

FBObjectFlag	GetObjectFlags (FBComponent arg1)
	Get all Object Flags (concatenated). More...

bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...

bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...

bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...

bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...

int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...

object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...

	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...

	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...

	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...

	HardSelect (FBComponent arg1)
	HardSelect. More...

object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBPlug
	__reduce__ ()

bool	BeginChange (FBPlug arg1)
	Begins a change on multiple plugs. More...

str	ClassName (FBPlug arg1)
	internal System vars. More...

bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...

bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...

bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...

bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...

	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...

	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...

bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...

bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...

bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...

	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...

object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...

int	GetDstCount (FBPlug arg1)
	Get destination connection count. More...

FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...

object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...

int	GetOwnedCount (FBPlug arg1)
	Get the owned plug count. More...

object	GetOwner (FBPlug arg1)
	Get the owner of this plug. More...

object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...

int	GetSrcCount (FBPlug arg1)
	Get source connection count. More...

FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...

bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...

bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...

	MoveSrcAt (...)

bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...

bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...

	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...

	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...

	__init__ (...)

method	staticmethod (function)

Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()

	__init__ (...)

Public Attributes
PropertyKeyPropertyBehavior	KeyPropertyBehavior
	Read Only Property: Key property behavior. More...

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

FBPropertyDouble	PathLength
	Read Only Property: Path Length In Centimeter. More...

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

PropertyUnitType	PathLengthUnit
	Read Write Property: Path Length Unit. More...

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

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

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

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

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

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

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

ORSDK2018::FBPropertyListModel	Children
	Interface to IObject. More...

FBPropertyVector3d	GeometricRotation
	Read Write Property: Geometric rotation. More...

FBPropertyVector3d	GeometricScaling
	Read Write Property: Geometric scaling. More...

FBPropertyVector3d	GeometricTranslation
	Read Write Property: Geometric translation. More...

FBPropertyGeometry	Geometry
	Read Write Property: Geometry for the model. More...

FBPropertyModelVertexData	ModelVertexData
	Read Only Property: ModelVertexData for the model. More...

FBPropertyBool	Icon3D
	Read Write Property: Is model a 3D icon? More...

FBPropertyBool	IsDeformable
	Read Only Property: Is model deformable? More...

FBPropertyBool	IsConstrained
	Read Only Property: Is model constrained? More...

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

FBPropertyBool	SkeletonDeformable
	Read Write Property: Model skeleton deformable. More...

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

FBPropertyBool	ConstrainDeformable
	Read Write Property: Model constraint deformable. More...

FBPropertyBool	PointCacheDeformable
	Read Write Property: Model point cache deformable. More...

FBPropertyBool	PointCacheRecord
	Read Write Property: Record Point Cache for model? Not Savable More...

FBPropertyColor	UniqueColorId
	Read Only Property: Unique Color Id for color based viewer picking. More...

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

FBPropertyModel	Parent
	Read Write Property: Parent model. More...

FBPropertyVector3d	PostRotation
	Read Write Property: Post Rotation (considered if RotationActive is true) More...

FBPropertyVector3d	PreRotation
	Read Write Property: Pre Rotation (considered if RotationActive is true) More...

FBPropertyBool	QuaternionInterpolate
	Read Write Property: Use quaternion interpolation. More...

FBPropertyBool	PrimaryVisibility
	Read Write Property: Control the geometry render state. More...

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

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

FBPropertyAnimatableVector3d	Rotation
	Read Write Property: Lcl rotation. More...

FBPropertyBool	RotationActive
	Read Write Property: Is model using Rotation Limits? More...

FBPropertyVector3d	RotationMax
	Read Write Property: Max Rotation Limit (considered if RotationActive is true) More...

FBPropertyBool	RotationMaxX
	Read Write Property: Is model using Maximum Rotation Limits On X? More...

FBPropertyBool	RotationMaxY
	Read Write Property: Is model using Maximum Rotation Limits On Y? More...

FBPropertyBool	RotationMaxZ
	Read Write Property: Is model using Maximum Rotation Limits On Z? More...

FBPropertyVector3d	RotationMin
	Read Write Property: Min Rotation Limit (considered if RotationActive is true) More...

FBPropertyBool	RotationMinX
	Read Write Property: Is model using Minimum Rotation Limits On X? More...

FBPropertyBool	RotationMinY
	Read Write Property: Is model using Minimum Rotation Limits On Y? More...

FBPropertyBool	RotationMinZ
	Read Write Property: Is model using Minimum Rotation Limits On Z? More...

FBPropertyModelRotationOrder	RotationOrder
	Read Write Property: Rotation order. More...

FBPropertyBool	RotationSpaceForLimitOnly
	Read Write Property: Apply Post Rotation Matrix only for Limits? More...

FBPropertyAnimatableVector3d	Scaling
	Read Write Property: Lcl scaling. More...

FBPropertyScene	Scene
	Read Only Property: Scene containing the model. More...

object	Selected

ORSDK2018::FBPropertyListShader	Shaders
	List: Shaders for model. More...

ORSDK2018::FBPropertyListMaterial	Materials
	List: Materials for model. More...

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

ORSDK2018::FBPropertyListDeformer	Deformers
	List: Deformers (Skeleton Deformer or Point Cache Deformer). More...

FBPropertyModelShadingMode	ShadingMode
	Read Write Property: Shading mode for the model. More...

object	CullingMode

FBPropertyBool	Pickable
	Read Write Property: Indicate if a model can be picked in the viewer. More...

FBPropertyBool	Show
	Read Write Property: Indicate if the viewer should show the object, according to its visibility value. More...

FBPropertyBool	Transformable
	Read Write Property: Indicate if a model can be transformable in the viewer. More...

FBPropertyBool	SoftSelected
	Read Write Property: Is model Soft selected? More...

FBPropertyAnimatableVector3d	Translation
	Read Write Property: Lcl translation. More...

FBPropertyModel	UpVector
	Read Write Property: UpVector model. More...

FBPropertyAnimatableBool	Visibility
	Read Write Property: Visibility of model. More...

object	IsVisible
	If the model is visible. More...

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

Public Attributes inherited from FBBox
FBPropertyBool	Animatable
	Read Write Property: Is the box animatable. More...

FBPropertyBool	Live
	Read Write Property: Is live? More...

FBPropertyBool	RecordMode
	Read Write Property: Is recording? More...

const char *	UniqueName
	internal Unique name. More...

Public Attributes inherited from FBComponent
object	OwnerNamespace

ORSDK2018::FBPropertyListComponent	Components
	List: List of components. More...

ORSDK2018::FBPropertyString	Name
	Read Write Property: Unique name of object. More...

ORSDK2018::FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

object	FullName

ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...

ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__	(	object	arg1,
		str	arg2
	)

Constructor.

Python Docstring:

__init__( (object)arg1, (str)arg2) -> None

C++ Signature:

 FBModelPath3D(const char * pName, HIObject pObject = ((void *) 0))

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

See the C++ reference

__reduce__ ( )

float ConvertSegmentPercentToTotalPercent	(	FBModelPath3D	arg1,
		object	arg2,
		FBEvaluateInfo	arg3
	)

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

Python Docstring:

ConvertSegmentPercentToTotalPercent( (FBModelPath3D)arg1, (object)arg2 [, (FBEvaluateInfo)arg3]) -> float

C++ Signature:

double ConvertSegmentPercentToTotalPercent(double pPercent, ORSDK2018::FBEvaluateInfo * pEvaluateInfo = ((void *) 0))

Parameters

pPercent Double value (as time)

Returns: Double value which represents the corresponding percentage

See the C++ reference

float ConvertToSegmentPercentFactor ( FBModelPath3D arg1 )

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

Python Docstring:

ConvertToSegmentPercentFactor( (FBModelPath3D)arg1) -> float

C++ Signature:

double ConvertToSegmentPercentFactor()

Returns: Returns the derivative multiplication factor

See the C++ reference

float ConvertTotalPercentToSegmentPercent	(	FBModelPath3D	arg1,
		object	arg2,
		FBEvaluateInfo	arg3
	)

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

Python Docstring:

ConvertTotalPercentToSegmentPercent( (FBModelPath3D)arg1, (object)arg2 [, (FBEvaluateInfo)arg3]) -> float

C++ Signature:

double ConvertTotalPercentToSegmentPercent(double pPercent, ORSDK2018::FBEvaluateInfo * pEvaluateInfo = ((void *) 0))

Parameters

pPercent Double value (as percentage)

Returns: Double value which represents the corresponding time.

See the C++ reference

float ConvertToTotalPercentFactor ( FBModelPath3D arg1 )

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

Python Docstring:

ConvertToTotalPercentFactor( (FBModelPath3D)arg1) -> float

C++ Signature:

double ConvertToTotalPercentFactor()

Returns: Returns the time factor

See the C++ reference

int GetSelectedPathKeyCount ( FBModelPath3D arg1 )

Query the number of keys present in the selected path.

Python Docstring:

GetSelectedPathKeyCount( (FBModelPath3D)arg1) -> int

C++ Signature:

int GetSelectedPathKeyCount()

Returns: Returns the number of keys in the selected path

See the C++ reference

int InsertNewEndKey ( FBModelPath3D arg1 )

Insert a new key at the end of the path.

Python Docstring:

InsertNewEndKey( (FBModelPath3D)arg1) -> int

C++ Signature:

int InsertNewEndKey()

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.

See the C++ reference

int InsertNewStartKey ( FBModelPath3D arg1 )

Insert a new key at the start of the path.

Python Docstring:

InsertNewStartKey( (FBModelPath3D)arg1) -> int

C++ Signature:

int InsertNewStartKey()

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

See the C++ reference

PathKeyClear ( FBModelPath3D arg1 )

Clear the path keys.

Python Docstring:

PathKeyClear( (FBModelPath3D)arg1) -> None

C++ Signature:

void PathKeyClear()

See the C++ reference

int PathKeyEndAdd	(	FBModelPath3D	arg1,
		FBVector4d	arg2
	)

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

Python Docstring:

PathKeyEndAdd( (FBModelPath3D)arg1, (FBVector4d)arg2) -> int

C++ Signature:

int PathKeyEndAdd(FBVector4d pTLocal)

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.

See the C++ reference

FBVector4d PathKeyGet	(	FBModelPath3D	arg1,
		object	arg2
	)

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

Python Docstring:

PathKeyGet( (FBModelPath3D)arg1, (object)arg2) -> FBVector4d

C++ Signature:

FBVector4d PathKeyGet(int pKeyIndex)

Parameters

pKeyIndex Key ID to set with

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

See the C++ reference

object PathKeyGetControlNode	(	FBModelPath3D	arg1,
		object	arg2
	)

Get the path key's control node.

Python Docstring:

PathKeyGetControlNode( (FBModelPath3D)arg1, (object)arg2) -> object

C++ Signature:

ORSDK2018::FBModel * PathKeyGetControlNode(int pKeyIndex)

Only works when KeyPropertyBehavior is eVector.

Parameters

pKeyIndex Key ID to get

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

See the C++ reference

int PathKeyGetCount ( FBModelPath3D arg1 )

Query the number of keys present in the path.

Python Docstring:

PathKeyGetCount( (FBModelPath3D)arg1) -> int

C++ Signature:

int PathKeyGetCount()

Returns: Number of keys present in the path

See the C++ reference

FBVector4d PathKeyGetLeftTangent	(	FBModelPath3D	arg1,
		object	arg2
	)

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

Python Docstring:

PathKeyGetLeftTangent( (FBModelPath3D)arg1, (object)arg2) -> FBVector4d

C++ Signature:

FBVector4d PathKeyGetLeftTangent(int pKeyIndex)

Parameters

pKeyIndex Key ID at which left tangent value is required

Returns: Vector containing value of left tangent

See the C++ reference

float PathKeyGetLeftTangentLength	(	FBModelPath3D	arg1,
		object	arg2
	)

Query the length of the left tangent.

Python Docstring:

PathKeyGetLeftTangentLength( (FBModelPath3D)arg1, (object)arg2) -> float

C++ Signature:

double PathKeyGetLeftTangentLength(int pKeyIndex)

Parameters

pKeyIndex Key ID to set with

Returns: Double value of the length of left tangent

See the C++ reference

object PathKeyGetProperty	(	FBModelPath3D	arg1,
		object	arg2
	)

Get the path key's corresponding property.

Python Docstring:

PathKeyGetProperty( (FBModelPath3D)arg1, (object)arg2) -> object

C++ Signature:

ORSDK2018::FBProperty * PathKeyGetProperty(int pKeyIndex)

Only works when KeyPropertyBehavior is eVector.

Parameters

pKeyIndex Key ID to get

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

See the C++ reference

FBVector4d PathKeyGetRightTangent	(	FBModelPath3D	arg1,
		object	arg2
	)

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

Python Docstring:

PathKeyGetRightTangent( (FBModelPath3D)arg1, (object)arg2) -> FBVector4d

C++ Signature:

FBVector4d PathKeyGetRightTangent(int pKeyIndex)

Parameters

pKeyIndex Key ID to set with

Returns: Vector containing value of left tangent

See the C++ reference

float PathKeyGetRightTangentLength	(	FBModelPath3D	arg1,
		object	arg2
	)

Query the value of the right tangent.

Python Docstring:

PathKeyGetRightTangentLength( (FBModelPath3D)arg1, (object)arg2) -> float

C++ Signature:

double PathKeyGetRightTangentLength(int pKeyIndex)

Parameters

pKeyIndex Key ID to set with

Returns: Double value of the length of right tangent

See the C++ reference

FBVector4d PathKeyGetXYZDerivative	(	FBModelPath3D	arg1,
		object	arg2
	)

Get vector in XYZ coordinates for a path tangent.

Python Docstring:

PathKeyGetXYZDerivative( (FBModelPath3D)arg1, (object)arg2) -> FBVector4d

C++ Signature:

FBVector4d PathKeyGetXYZDerivative(int pKeyIndex)

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

See the C++ reference

int PathKeyInsertAfter	(	FBModelPath3D	arg1,
		object	arg2,
		FBVector4d	arg3
	)

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

Python Docstring:

PathKeyInsertAfter( (FBModelPath3D)arg1, (object)arg2, (FBVector4d)arg3) -> int

C++ Signature:

int PathKeyInsertAfter(int pKeyIndex, FBVector4d pTLocal)

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.

See the C++ reference

PathKeyRemove	(	FBModelPath3D	arg1,
		object	arg2
	)

Remove key at a particular index.

Python Docstring:

PathKeyRemove( (FBModelPath3D)arg1, (object)arg2) -> None

C++ Signature:

void PathKeyRemove(int pKeyIndex)

Parameters

pKeyIndex Key ID at which key is to be removed.

See the C++ reference

PathKeyRemoveSelected ( FBModelPath3D arg1 )

Remove the selected keys from the path.

Python Docstring:

PathKeyRemoveSelected( (FBModelPath3D)arg1) -> None

C++ Signature:

void PathKeyRemoveSelected()

See the C++ reference

PathKeySet	(	FBModelPath3D	arg1,
		object	arg2,
		FBVector4d	arg3,
		object	arg4
	)

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

Python Docstring:

PathKeySet( (FBModelPath3D)arg1, (object)arg2, (FBVector4d)arg3 [, (object)arg4]) -> None

C++ Signature:

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

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)

See the C++ reference

bool PathKeySetControlNode	(	FBModelPath3D	arg1,
		object	arg2,
		FBModel	arg3
	)

Set the path key's control node.

Python Docstring:

PathKeySetControlNode( (FBModelPath3D)arg1, (object)arg2, (FBModel)arg3) -> bool

C++ Signature:

bool PathKeySetControlNode(int pKeyIndex, ORSDK2018::FBModel * pControlNode)

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.

See the C++ reference

PathKeySetLeftRightTangent	(	FBModelPath3D	arg1,
		object	arg2,
		FBVector4d	arg3,
		FBVector4d	arg4,
		FBVector4d	arg5,
		object	arg6
	)

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

Python Docstring:

PathKeySetLeftRightTangent( (FBModelPath3D)arg1, (object)arg2, (FBVector4d)arg3, (FBVector4d)arg4, (FBVector4d)arg5 [, (object)arg6]) -> None

C++ Signature:

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

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)

See the C++ reference

PathKeySetLeftTangent	(	FBModelPath3D	arg1,
		object	arg2,
		FBVector4d	arg3,
		object	arg4
	)

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

Python Docstring:

PathKeySetLeftTangent( (FBModelPath3D)arg1, (object)arg2, (FBVector4d)arg3 [, (object)arg4]) -> None

C++ Signature:

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

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)

See the C++ reference

PathKeySetRightTangent	(	FBModelPath3D	arg1,
		object	arg2,
		FBVector4d	arg3,
		object	arg4
	)

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

Python Docstring:

PathKeySetRightTangent( (FBModelPath3D)arg1, (object)arg2, (FBVector4d)arg3 [, (object)arg4]) -> None

C++ Signature:

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

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)

See the C++ reference

PathKeySetXDerivative	(	FBModelPath3D	arg1,
		object	arg2,
		object	arg3,
		object	arg4
	)

Set derivative in X coordinate for a path tangent.

Python Docstring:

PathKeySetXDerivative( (FBModelPath3D)arg1, (object)arg2, (object)arg3, (object)arg4) -> None

C++ Signature:

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

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)

See the C++ reference

PathKeySetXYZDerivative	(	FBModelPath3D	arg1,
		object	arg2,
		FBVector4d	arg3,
		object	arg4
	)

Set derivative in XYZ coordinates for a path tangent.

Python Docstring:

PathKeySetXYZDerivative( (FBModelPath3D)arg1, (object)arg2, (FBVector4d)arg3, (object)arg4) -> None

C++ Signature:

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

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)

See the C++ reference

PathKeySetYDerivative	(	FBModelPath3D	arg1,
		object	arg2,
		object	arg3,
		object	arg4
	)

Set derivative in Y coordinate for a path tangent.

Python Docstring:

PathKeySetYDerivative( (FBModelPath3D)arg1, (object)arg2, (object)arg3, (object)arg4) -> None

C++ Signature:

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

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)

See the C++ reference

PathKeySetZDerivative	(	FBModelPath3D	arg1,
		object	arg2,
		object	arg3,
		object	arg4
	)

Set derivative in Z coordinate for a path tangent.

Python Docstring:

PathKeySetZDerivative( (FBModelPath3D)arg1, (object)arg2, (object)arg3, (object)arg4) -> None

C++ Signature:

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

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)

See the C++ reference

int PathKeyStartAdd	(	FBModelPath3D	arg1,
		FBVector4d	arg2
	)

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

Python Docstring:

PathKeyStartAdd( (FBModelPath3D)arg1, (FBVector4d)arg2) -> int

C++ Signature:

int PathKeyStartAdd(FBVector4d pTLocal)

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.

See the C++ reference

FBVector4d Segment_GlobalPathEvaluate	(	FBModelPath3D	arg1,
		object	arg2,
		FBEvaluateInfo	arg3
	)

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

Python Docstring:

Segment_GlobalPathEvaluate( (FBModelPath3D)arg1, (object)arg2 [, (FBEvaluateInfo)arg3]) -> FBVector4d

C++ Signature:

FBVector4d Segment_GlobalPathEvaluate(double pSegmentPercent, ORSDK2018::FBEvaluateInfo * pEvaluateInfo = ((void *) 0))

Parameters

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

Returns: Vector value at the required point in the path

See the C++ reference

FBVector4d Segment_GlobalPathEvaluateDerivative	(	FBModelPath3D	arg1,
		object	arg2,
		FBEvaluateInfo	arg3
	)

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

Python Docstring:

Segment_GlobalPathEvaluateDerivative( (FBModelPath3D)arg1, (object)arg2 [, (FBEvaluateInfo)arg3]) -> FBVector4d

C++ Signature:

FBVector4d Segment_GlobalPathEvaluateDerivative(double pSegmentPercent, ORSDK2018::FBEvaluateInfo * pEvaluateInfo = ((void *) 0))

Parameters

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

Returns: Vector value at the required point in the path

See the C++ reference

int Segment_IsPathKey	(	FBModelPath3D	arg1,
		object	arg2,
		FBEvaluateInfo	arg3
	)

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

Python Docstring:

Segment_IsPathKey( (FBModelPath3D)arg1, (object)arg2 [, (FBEvaluateInfo)arg3]) -> int

C++ Signature:

int Segment_IsPathKey(double pSegmentPercent, ORSDK2018::FBEvaluateInfo * pEvaluateInfo = ((void *) 0))

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

See the C++ reference

FBVector4d Segment_LocalPathEvaluate	(	FBModelPath3D	arg1,
		object	arg2,
		FBEvaluateInfo	arg3
	)

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

Python Docstring:

Segment_LocalPathEvaluate( (FBModelPath3D)arg1, (object)arg2 [, (FBEvaluateInfo)arg3]) -> FBVector4d

C++ Signature:

FBVector4d Segment_LocalPathEvaluate(double pSegmentPercent, ORSDK2018::FBEvaluateInfo * pEvaluateInfo = ((void *) 0))

Parameters

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

Returns: Vector value at the required point in the path

See the C++ reference

FBVector4d Segment_LocalPathEvaluateDerivative	(	FBModelPath3D	arg1,
		object	arg2,
		FBEvaluateInfo	arg3
	)

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

Python Docstring:

Segment_LocalPathEvaluateDerivative( (FBModelPath3D)arg1, (object)arg2 [, (FBEvaluateInfo)arg3]) -> FBVector4d

C++ Signature:

FBVector4d Segment_LocalPathEvaluateDerivative(double pSegmentPercent, ORSDK2018::FBEvaluateInfo * pEvaluateInfo = ((void *) 0))

Parameters

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

Returns: Vector value at the required point in the path

See the C++ reference

int Segment_PathKeyAdd	(	FBModelPath3D	arg1,
		object	arg2,
		FBVector4d	arg3,
		FBEvaluateInfo	arg4
	)

Adds a new key either at the start, end or along the path as per specified.

Python Docstring:

Segment_PathKeyAdd( (FBModelPath3D)arg1, (object)arg2, (FBVector4d)arg3 [, (FBEvaluateInfo)arg4]) -> int

C++ Signature:

int Segment_PathKeyAdd(double pSegmentPercent, FBVector4d pTLocal, ORSDK2018::FBEvaluateInfo * pEvaluateInfo = ((void *) 0))

Parameters

pSegmentPercent	Double value indicating where the key is to be added. If < 0, key added before start of the path, if > 0, key added at end of path, otherwise it is added somewhere along the path depending on value specified
pTLocal	Vector to use to set values to Key

Returns: Vector value at the required point in the path

See the C++ reference

ShowCurveControls	(	FBModelPath3D	arg1,
		object	arg2
	)

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

Python Docstring:

ShowCurveControls( (FBModelPath3D)arg1, (object)arg2) -> None

C++ Signature:

void ShowCurveControls(bool pShow)

Parameters

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

See the C++ reference

ShowCurvePoints	(	FBModelPath3D	arg1,
		object	arg2
	)

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

Python Docstring:

ShowCurvePoints( (FBModelPath3D)arg1, (object)arg2) -> None

C++ Signature:

void ShowCurvePoints(bool pShow)

Parameters

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

See the C++ reference

FBVector4d Total_GlobalPathEvaluate	(	FBModelPath3D	arg1,
		object	arg2,
		FBEvaluateInfo	arg3
	)

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

Python Docstring:

Total_GlobalPathEvaluate( (FBModelPath3D)arg1, (object)arg2 [, (FBEvaluateInfo)arg3]) -> FBVector4d

C++ Signature:

FBVector4d Total_GlobalPathEvaluate(double pTotalPercent, ORSDK2018::FBEvaluateInfo * pEvaluateInfo = ((void *) 0))

Parameters

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

Returns: Vector value at the required point in the path

See the C++ reference

FBVector4d Total_GlobalPathEvaluateDerivative	(	FBModelPath3D	arg1,
		object	arg2,
		FBEvaluateInfo	arg3
	)

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

Python Docstring:

Total_GlobalPathEvaluateDerivative( (FBModelPath3D)arg1, (object)arg2 [, (FBEvaluateInfo)arg3]) -> FBVector4d

C++ Signature:

FBVector4d Total_GlobalPathEvaluateDerivative(double pTotalPercent, ORSDK2018::FBEvaluateInfo * pEvaluateInfo = ((void *) 0))

Parameters

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

Returns: Derivative value at the required point in the path

See the C++ reference

int Total_IsPathKey	(	FBModelPath3D	arg1,
		object	arg2,
		FBEvaluateInfo	arg3
	)

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

Python Docstring:

Total_IsPathKey( (FBModelPath3D)arg1, (object)arg2 [, (FBEvaluateInfo)arg3]) -> int

C++ Signature:

int Total_IsPathKey(double pTotalPercent, ORSDK2018::FBEvaluateInfo * pEvaluateInfo = ((void *) 0))

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

See the C++ reference

FBVector4d Total_LocalPathEvaluate	(	FBModelPath3D	arg1,
		object	arg2,
		FBEvaluateInfo	arg3
	)

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

Python Docstring:

Total_LocalPathEvaluate( (FBModelPath3D)arg1, (object)arg2 [, (FBEvaluateInfo)arg3]) -> FBVector4d

C++ Signature:

FBVector4d Total_LocalPathEvaluate(double pTotalPercent, ORSDK2018::FBEvaluateInfo * pEvaluateInfo = ((void *) 0))

Parameters

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

Returns: Vector value at the required point in the path

See the C++ reference

FBVector4d Total_LocalPathEvaluateDerivative	(	FBModelPath3D	arg1,
		object	arg2,
		FBEvaluateInfo	arg3
	)

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

Python Docstring:

Total_LocalPathEvaluateDerivative( (FBModelPath3D)arg1, (object)arg2 [, (FBEvaluateInfo)arg3]) -> FBVector4d

C++ Signature:

FBVector4d Total_LocalPathEvaluateDerivative(double pTotalPercent, ORSDK2018::FBEvaluateInfo * pEvaluateInfo = ((void *) 0))

Parameters

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

Returns: Derivative value at the required point in the path

See the C++ reference

int Total_PathKeyAdd	(	FBModelPath3D	arg1,
		object	arg2,
		FBVector4d	arg3,
		FBEvaluateInfo	arg4
	)

Adds a new key either at the start, end or along the path as per specified.

Python Docstring:

Total_PathKeyAdd( (FBModelPath3D)arg1, (object)arg2, (FBVector4d)arg3 [, (FBEvaluateInfo)arg4]) -> int

C++ Signature:

int Total_PathKeyAdd(double pTotalPercent, FBVector4d pTLocal, ORSDK2018::FBEvaluateInfo * pEvaluateInfo = ((void *) 0))

Parameters

pTotalPercent	Double value indicating where the key is to be added. If < 0, key added before start of the path, if > 0, key added at end of path, otherwise it is added somewhere along the path depending on value specified
pTLocal	Vector to use to set values to Key

Returns: Index as integer for the path key added

See the C++ reference

UpdateGeometry ( FBModelPath3D arg1 )

Update path geometry explicitly.

Python Docstring:

UpdateGeometry( (FBModelPath3D)arg1) -> None

C++ Signature:

void UpdateGeometry()

See the C++ reference

Member Data Documentation

FBPropertyBool AutoControlNode

Read Write Property: Automatically create key control nodes.

See the C++ reference

FBPropertyAnimatableColor Color

Read Write Property: Path display color in viewport.

See the C++ reference

PropertyKeyPropertyBehavior KeyPropertyBehavior

Read Only Property: Key property behavior.

See the C++ reference

FBPropertyDouble PathEndCapScale

Read Write Property: Path end cap display scale.

See the C++ reference

PropertyPathEndCapStyle PathEndCapStyle

Read Write Property: Path end cap display style.

See the C++ reference

FBPropertyDouble PathLength

Read Only Property: Path Length In Centimeter.

See the C++ reference

ORSDK2018::FBPropertyString PathLengthInString

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

See the C++ reference

FBPropertyBool PathLengthShow

Read Write Property: Path length label display or not.

See the C++ reference

PropertyUnitType PathLengthUnit

Read Write Property: Path Length Unit.

See the C++ reference

FBPropertyColorAndAlpha TextBackground

Read Write Property: Path Length label display background color.

See the C++ reference

FBPropertyDouble TextScale

Read Write Property: Path Length label display scale.

See the C++ reference

FBModelPath3D Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation