Path 3D model class.
Public Member Functions | |
__init__ (str pName, object pObject=None) | |
Constructor. | |
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. | |
int | PathKeyGetCount () |
Query the number of keys present in the path. | |
FBVector4 | PathKeyGet (int pKeyIndex) |
Get path's key vector for at a particular key index. | |
PathKeySet (int pKeyIndex, FBVector4 pTLocal, bool pUpdate=True) | |
Set the local coordinate vector values for path at a particular key index. | |
PathKeySetLeftRightTangent (int pKeyIndex, FBVector4 pKeyTLocal, FBVector4 pLeftTangentTLocal, FBVector4 pRightTangentTLocal, bool pUpdate=True) | |
Set path's vectors for key, left tangent and right tangent at a particular key index. | |
PathKeyRemove (int pKeyIndex) | |
Remove key at a particular index. | |
PathKeyClear () | |
Clear the path keys. | |
PathKeySetLeftTangent (int pKeyIndex, FBVector4 pTLocal, bool pUpdate=True) | |
Set path's key left tangent vector for designated index. | |
PathKeySetRightTangent (int pKeyIndex, FBVector4 pTLocal, bool pUpdate=True) | |
Set 3D path's key right tangent vector for designated index. | |
FBVector4 | PathKeyGetLeftTangent (int pKeyIndex) |
Get the path key left tangent's vector value for designated index. | |
FBVector4 | PathKeyGetRightTangent (int pKeyIndex) |
Get the path key right tangent's vector value for designated index. | |
PathKeySetXDerivative (int pKeyIndex, float pDerivative, bool pUpdate) | |
Set derivative in X coordinate 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. | |
PathKeySetXYZDerivative (int pKeyIndex, FBVector4 pDerivative, bool pUpdate) | |
Set derivative in XYZ coordinates for a path tangent. | |
FBVector4 | PathKeyGetXYZDerivative (int pKeyIndex) |
Get vector in XYZ coordinates for a path tangent. | |
float | PathKeyGetLeftTangentLength (int pKeyIndex) |
Query the length of the left tangent. | |
float | PathKeyGetRightTangentLength (int pKeyIndex) |
Query the value of the right tangent. | |
int | GetSelectedPathKeyCount () |
Query the number of keys present in the selected path. | |
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 (FBVector4 pTLocal) |
Adds a new key to the start of the path (with time gap of 1 sec). | |
int | PathKeyEndAdd (FBVector4 pTLocal) |
Adds a new key to the end of the path (with time gap of 1 sec). | |
int | Total_PathKeyAdd (float pTotalPercent, FBVector4 pTLocal) |
Adds a new key either at the start, end or along the path as per specified. | |
int | Total_IsPathKey (float pTotalPercent) |
Query whether a percentage value has a key associated at that point in the path. | |
FBVector4 | Total_GlobalPathEvaluate (float pTotalPercent) |
Get the path's vector at a particular point within the curve, in global coordinates. | |
FBVector4 | Total_LocalPathEvaluate (float pTotalPercent) |
Get the path's vector at a particular point within the curve, in local coordinates. | |
FBVector4 | Total_GlobalPathEvaluateDerivative (float pTotalPercent) |
Get the path's derivative at a particular point within the curve, in global coordinates. | |
FBVector4 | Total_LocalPathEvaluateDerivative (float pTotalPercent) |
Get the path's derivative at a particular point within the curve, in local coordinates. | |
int | Segment_PathKeyAdd (float pSegmentPercent, FBVector4 pTLocal) |
Adds a new key either at the start, end or along the path as per specified. | |
int | Segment_IsPathKey (float pSegmentPercent) |
Query whether a percentage value has a key associated at that point in the path. | |
FBVector4 | Segment_GlobalPathEvaluate (float pSegmentPercent) |
Get the path's vector at a particular point within the curve, in global coordinates. | |
FBVector4 | Segment_LocalPathEvaluate (float pSegmentPercent) |
Get the path's vector at a particular point within the curve, in local coordinates. | |
FBVector4 | Segment_GlobalPathEvaluateDerivative (float pSegmentPercent) |
Get the path's derivative at a particular point within the curve, in global coordinates. | |
FBVector4 | Segment_LocalPathEvaluateDerivative (float pSegmentPercent) |
Get the path's derivative at a particular point within the curve, in local coordinates. | |
float | ConvertTotalPercentToSegmentPercent (float pPercent) |
Converting one key type Total (percent) to Segment (time). | |
float | ConvertSegmentPercentToTotalPercent (float pPercent) |
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. | |
UpdateGeometry () | |
Update path geometry explicitly. | |
Public Attributes | |
FBPropertyBase | PathLength |
Read Only Property: Path Length In Centimeter. | |
FBPropertyString | PathLengthInString |
Read Only Property: Path Length Display String According To The Current Unit. | |
PropertyUnitType | PathLengthUnit |
Read Write Property: Path Length Unit. | |
FBPropertyBase | PathLengthShow |
Read Write Property: Path length label display or not. | |
FBPropertyBase | TextScale |
Read Write Property: Path Length label display scale. | |
FBPropertyBase | TextBackground |
Read Write Property: Path Length label display background color. | |
PropertyPathEndCapStyle | PathEndCapStyle |
Read Write Property: Path end cap display style. | |
FBPropertyBase | PathEndCapScale |
Read Write Property: Path end cap display scale. | |
FBPropertyBaseAnimatable | Color |
Read Write Property: Path display color in viewport. |
Constructor.
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))
Reimplemented from FBModel.
ShowCurveControls | ( | bool | pShow | ) |
Enable or disable displaying Curve Controls for the 3D model path.
pShow | true if curve controls are to be displayed false if not required |
ShowCurvePoints | ( | bool | pShow | ) |
Enable or disable displaying Curve Points for the 3D model path.
pShow | true if curve points are to be displayed false if not required |
int PathKeyGetCount | ( | ) |
Query the number of keys present in the path.
FBVector4 PathKeyGet | ( | int | pKeyIndex | ) |
Get path's key vector for at a particular key index.
pKeyIndex | Key ID to set with |
Set the local coordinate vector values for path at a particular key index.
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) |
PathKeySetLeftRightTangent | ( | int | pKeyIndex, |
FBVector4 | pKeyTLocal, | ||
FBVector4 | pLeftTangentTLocal, | ||
FBVector4 | pRightTangentTLocal, | ||
bool | pUpdate = True |
||
) |
Set path's vectors for key, left tangent and right tangent at a particular key index.
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) |
PathKeyRemove | ( | int | pKeyIndex | ) |
Remove key at a particular index.
pKeyIndex | Key ID at which key is to be removed. |
PathKeyClear | ( | ) |
Clear the path keys.
Set path's key left tangent vector for designated index.
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) |
Set 3D path's key right tangent vector for designated index.
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) |
FBVector4 PathKeyGetLeftTangent | ( | int | pKeyIndex | ) |
Get the path key left tangent's vector value for designated index.
pKeyIndex | Key ID at which left tangent value is required |
FBVector4 PathKeyGetRightTangent | ( | int | pKeyIndex | ) |
Get the path key right tangent's vector value for designated index.
pKeyIndex | Key ID to set with |
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.
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) |
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.
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) |
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.
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) |
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.
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) |
FBVector4 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.
pKeyIndex | Key ID to set with |
Query the length of the left tangent.
pKeyIndex | Key ID to set with |
Query the value of the right tangent.
pKeyIndex | Key ID to set with |
int GetSelectedPathKeyCount | ( | ) |
Query the number of keys present in the selected path.
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 | ( | FBVector4 | 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.
pTLocal | Vector value for the new added Key |
int PathKeyEndAdd | ( | FBVector4 | 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.
pTLocal | Vector value for the new added Key |
Adds a new key either at the start, end or along the path as per specified.
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 |
Query whether a percentage value has a key associated at that point in the path.
pTotalPercent | Double value (as percentage) at which the path would be queried for existence of key |
FBVector4 Total_GlobalPathEvaluate | ( | float | pTotalPercent | ) |
Get the path's vector at a particular point within the curve, in global coordinates.
pTotalPercent | Double value (as percentage) at which the path vector would be computed |
FBVector4 Total_LocalPathEvaluate | ( | float | pTotalPercent | ) |
Get the path's vector at a particular point within the curve, in local coordinates.
pTotalPercent | Double value (as percentage) at which the path vector would be computed |
FBVector4 Total_GlobalPathEvaluateDerivative | ( | float | pTotalPercent | ) |
Get the path's derivative at a particular point within the curve, in global coordinates.
pTotalPercent | Double value (as percentage) at which the path derivative would be computed |
FBVector4 Total_LocalPathEvaluateDerivative | ( | float | pTotalPercent | ) |
Get the path's derivative at a particular point within the curve, in local coordinates.
pTotalPercent | Double value (as percentage) at which the path derivative would be computed |
Adds a new key either at the start, end or along the path as per specified.
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 |
Query whether a percentage value has a key associated at that point in the path.
pSegmentPercent | Double value (as time) at which the path would be queried for existence of key |
FBVector4 Segment_GlobalPathEvaluate | ( | float | pSegmentPercent | ) |
Get the path's vector at a particular point within the curve, in global coordinates.
pSegmentPercent | Double value (as time) at which the path vector would be computed |
FBVector4 Segment_LocalPathEvaluate | ( | float | pSegmentPercent | ) |
Get the path's vector at a particular point within the curve, in local coordinates.
pSegmentPercent | Double value (as time) at which the path vector would be computed |
FBVector4 Segment_GlobalPathEvaluateDerivative | ( | float | pSegmentPercent | ) |
Get the path's derivative at a particular point within the curve, in global coordinates.
pSegmentPercent | Double value (as time) at which the path derivative would be computed |
FBVector4 Segment_LocalPathEvaluateDerivative | ( | float | pSegmentPercent | ) |
Get the path's derivative at a particular point within the curve, in local coordinates.
pSegmentPercent | Double value (as time) at which the path derivative would be computed |
Converting one key type Total (percent) to Segment (time).
pPercent | Double value (as percentage) |
Converting one key type Segment (time) to Total (percent).
pPercent | Double value (as time) |
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.
UpdateGeometry | ( | ) |
Update path geometry explicitly.
FBPropertyBase PathLength |
Read Only Property: Path Length In Centimeter.
Read Only Property: Path Length Display String According To The Current Unit.
PropertyUnitType PathLengthUnit |
Read Write Property: Path Length Unit.
FBPropertyBase PathLengthShow |
Read Write Property: Path length label display or not.
FBPropertyBase TextScale |
Read Write Property: Path Length label display scale.
FBPropertyBase TextBackground |
Read Write Property: Path Length label display background color.
PropertyPathEndCapStyle PathEndCapStyle |
Read Write Property: Path end cap display style.
FBPropertyBase PathEndCapScale |
Read Write Property: Path end cap display scale.
FBPropertyBaseAnimatable Color |
Read Write Property: Path display color in viewport.