FBModelPath3D Class Reference

This reference page is linked to from the following overview topics: FBModel - Transformation Data and the Scene Graph.

---

Search for all occurrences

---

Detailed Description

Path 3D model class.

Definition at line 63 of file fbmodelpath3d.h.

#include <fbmodelpath3d.h>

Inheritance diagram for FBModelPath3D:

List of all members.

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.
K_DEPRECATED void	PathSetKeyLeftRightTangeant (int pKeyIndex, FBVector4d pKeyTLocal, FBVector4d pLeftTangentTLocal, FBVector4d pRightTangentTLocal, bool pUpdate=true)
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.
K_DEPRECATED void	PathKeySetLeftTangeant (int pKeyIndex, FBVector4d pTLocal, bool pUpdate=true)
void	PathKeySetLeftTangent (int pKeyIndex, FBVector4d pTLocal, bool pUpdate=true)
	Set path's key left tangent vector for designated index.
K_DEPRECATED void	PathKeySetRightTangeant (int pKeyIndex, FBVector4d pTLocal, bool pUpdate=true)
void	PathKeySetRightTangent (int pKeyIndex, FBVector4d pTLocal, bool pUpdate=true)
	Set 3D path's key right tangent vector for designated index.
K_DEPRECATED FBVector4d	PathKeyGetLeftTangeant (int pKeyIndex)
FBVector4d	PathKeyGetLeftTangent (int pKeyIndex)
	Get the path key left tangent's vector value for designated index.
K_DEPRECATED FBVector4d	PathKeyGetRightTangeant (int pKeyIndex)
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.
K_DEPRECATED double	PatKeyGetLeftTangeantLength (int pKeyIndex)
double	PathKeyGetLeftTangentLength (int pKeyIndex)
	Query the length of the left tangent.
K_DEPRECATED double	PatKeyGetRightTangeantLength (int pKeyIndex)
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	Total_PathKeyAdd (double pTotalPercent, FBVector4d pTLocal)
	Adds a new key either at the start, end or along the path as per specified.
int	Total_IsPathKey (double pTotalPercent)
	Query whether a percentage value has a key associated at that point in the path.
FBVector4d	Total_GlobalPathEvaluate (double pTotalPercent)
	Get the path's vector at a particular point within the curve, in global coordinates.
FBVector4d	Total_LocalPathEvaluate (double pTotalPercent)
	Get the path's vector at a particular point within the curve, in local coordinates.
FBVector4d	Total_GlobalPathEvaluateDerivative (double pTotalPercent)
	Get the path's derivative at a particular point within the curve, in global coordinates.
FBVector4d	Total_LocalPathEvaluateDerivative (double pTotalPercent)
	Get the path's derivative at a particular point within the curve, in local coordinates.
int	Segment_PathKeyAdd (double pSegmentPercent, FBVector4d pTLocal)
	Adds a new key either at the start, end or along the path as per specified.
int	Segment_IsPathKey (double pSegmentPercent)
	Query whether a percentage value has a key associated at that point in the path.
FBVector4d	Segment_GlobalPathEvaluate (double pSegmentPercent)
	Get the path's vector at a particular point within the curve, in global coordinates.
FBVector4d	Segment_LocalPathEvaluate (double pSegmentPercent)
	Get the path's vector at a particular point within the curve, in local coordinates.
FBVector4d	Segment_GlobalPathEvaluateDerivative (double pSegmentPercent)
	Get the path's derivative at a particular point within the curve, in global coordinates.
FBVector4d	Segment_LocalPathEvaluateDerivative (double pSegmentPercent)
	Get the path's derivative at a particular point within the curve, in local coordinates.
double	ConvertTotalPercentToSegmentPercent (double pPercent)
	Converting one key type Total (percent) to Segment (time).
double	ConvertSegmentPercentToTotalPercent (double pPercent)
	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 Attributes
FBPropertyAnimatableColor	Color

---

Constructor & Destructor Documentation

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

Constructor.

Parameters:

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

Python sample code:

        Script Sample.
        from pyfbsdk import *

        path = FBModelPath3D("Test")
        path.Show = True
        der = path.Total_LocalPathEvaluateDerivative(1)
        path.PathKeySetLeftTangeant(1,FBVector4d(25,25,25,25),True)
        ## Add keys at start and end
        path.PathKeyStartAdd(FBVector4d(0,0,100,0))
        path.PathKeyEndAdd(FBVector4d(100,0,0,0))
        ## Add keys within the path
        path.Segment_PathKeyAdd(75.0,FBVector4d(25,25,25,25))
        path.Segment_PathKeyAdd(25.0,FBVector4d(25,0,25,25))

---

Member Function Documentation

void ShowCurveControls

(

bool

pShow

)

Search for all occurrences

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

void ShowCurvePoints

(

bool

pShow

)

Search for all occurrences

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

int PathKeyGetCount

(

)

Search for all occurrences

Query the number of keys present in the path.

Returns:

Number of keys present in the path

FBVector4d PathKeyGet

(

int

pKeyIndex

)

Search for all occurrences

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.

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

Search for all occurrences

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)

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

Search for all occurrences

Deprecated:

Use FBModelPath3D::PathKeySetLeftRightTangent() instead.

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)

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

Search for all occurrences

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)

void PathKeyRemove

(

int

pKeyIndex

)

Search for all occurrences

Remove key at a particular index.

Parameters:

pKeyIndex

Key ID at which key is to be removed.

void PathKeyClear

(

)

Search for all occurrences

Clear the path keys.

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

Search for all occurrences

Deprecated:

Use FBModelPath3D::PathKeySetLeftTangent() instead.

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

Parameters:

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

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

Search for all occurrences

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

Parameters:

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

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

Search for all occurrences

Deprecated:

Use FBModelPath3D::PathKeySetRightTangent() instead.

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

Parameters:

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

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

Search for all occurrences

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

Parameters:

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

K_DEPRECATED FBVector4d PathKeyGetLeftTangeant

(

int

pKeyIndex

)

Search for all occurrences

Deprecated:

Use FBModelPath3D::PathKeyGetLeftTangent() instead.

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

FBVector4d PathKeyGetLeftTangent

(

int

pKeyIndex

)

Search for all occurrences

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

K_DEPRECATED FBVector4d PathKeyGetRightTangeant

(

int

pKeyIndex

)

Search for all occurrences

Deprecated:

Use FBModelPath3D::PathKeyGetRightTangent() instead.

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

FBVector4d PathKeyGetRightTangent

(

int

pKeyIndex

)

Search for all occurrences

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

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

Search for all occurrences

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)

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

Search for all occurrences

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)

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

Search for all occurrences

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)

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

Search for all occurrences

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)

FBVector4d PathKeyGetXYZDerivative

(

int

pKeyIndex

)

Search for all occurrences

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

K_DEPRECATED double PatKeyGetLeftTangeantLength

(

int

pKeyIndex

)

Search for all occurrences

Deprecated:

Use FBModelPath3D::PathKeyGetLeftTangentLength() instead.

Query the length of the left tangent.

Parameters:

pKeyIndex

Key ID to set with

Returns:

Double value of the length of left tangent

double PathKeyGetLeftTangentLength

(

int

pKeyIndex

)

Search for all occurrences

Query the length of the left tangent.

Parameters:

pKeyIndex

Key ID to set with

Returns:

Double value of the length of left tangent

K_DEPRECATED double PatKeyGetRightTangeantLength

(

int

pKeyIndex

)

Search for all occurrences

Deprecated:

Use FBModelPath3D::PathKeyGetRightTangentLength() instead.

Query the value of the right tangent.

Parameters:

pKeyIndex

Key ID to set with

Returns:

Double value of the length of right tangent

double PathKeyGetRightTangentLength

(

int

pKeyIndex

)

Search for all occurrences

Query the value of the right tangent.

Parameters:

pKeyIndex

Key ID to set with

Returns:

Double value of the length of right tangent

int GetSelectedPathKeyCount

(

)

Search for all occurrences

Query the number of keys present in the selected path.

Returns:

Returns the number of keys in the selected path

void PathKeyRemoveSelected

(

)

Search for all occurrences

Remove the selected keys from the path.

int InsertNewStartKey

(

)

Search for all occurrences

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.

int InsertNewEndKey

(

)

Search for all occurrences

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.

int PathKeyStartAdd

(

FBVector4d

pTLocal

)

Search for all occurrences

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.

int PathKeyEndAdd

(

FBVector4d

pTLocal

)

Search for all occurrences

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.

int Total_PathKeyAdd	(	double	pTotalPercent,
		FBVector4d	pTLocal
	)

Search for all occurrences

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

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

int Total_IsPathKey

(

double

pTotalPercent

)

Search for all occurrences

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

FBVector4d Total_GlobalPathEvaluate

(

double

pTotalPercent

)

Search for all occurrences

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

FBVector4d Total_LocalPathEvaluate

(

double

pTotalPercent

)

Search for all occurrences

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

FBVector4d Total_GlobalPathEvaluateDerivative

(

double

pTotalPercent

)

Search for all occurrences

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

FBVector4d Total_LocalPathEvaluateDerivative

(

double

pTotalPercent

)

Search for all occurrences

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

int Segment_PathKeyAdd	(	double	pSegmentPercent,
		FBVector4d	pTLocal
	)

Search for all occurrences

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

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:

Vector value at the required point in the path

int Segment_IsPathKey

(

double

pSegmentPercent

)

Search for all occurrences

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

Parameters:

pTotalPercent

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

FBVector4d Segment_GlobalPathEvaluate

(

double

pSegmentPercent

)

Search for all occurrences

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

Parameters:

pTotalPercent

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

Returns:

Vector value at the required point in the path

FBVector4d Segment_LocalPathEvaluate

(

double

pSegmentPercent

)

Search for all occurrences

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

Parameters:

pTotalPercent

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

Returns:

Vector value at the required point in the path

FBVector4d Segment_GlobalPathEvaluateDerivative

(

double

pSegmentPercent

)

Search for all occurrences

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

Parameters:

pTotalPercent

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

Returns:

Vector value at the required point in the path

FBVector4d Segment_LocalPathEvaluateDerivative

(

double

pSegmentPercent

)

Search for all occurrences

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

Parameters:

pTotalPercent

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

Returns:

Vector value at the required point in the path

double ConvertTotalPercentToSegmentPercent

(

double

pPercent

)

Search for all occurrences

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

Parameters:

pPercent

Double value (as percentage)

Returns:

Double value which represents the corresponding time.

double ConvertSegmentPercentToTotalPercent

(

double

pPercent

)

Search for all occurrences

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

Parameters:

pPercent

Double value (as time)

Returns:

Double value which represents the corresponding percentage

double ConvertToSegmentPercentFactor

(

)

Search for all occurrences

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

Returns:

Returns the derivative multiplication factor

double ConvertToTotalPercentFactor

(

)

Search for all occurrences

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

Returns:

Returns the time factor

void UpdateGeometry

(

)

Search for all occurrences

Update path geometry explicitly.

---

Member Data Documentation

FBPropertyAnimatableColor Color

Search for all occurrences

Definition at line 69 of file fbmodelpath3d.h.

---

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

• fbsdk/fbmodelpath3d.h