FBModelPath3D Class Reference


Detailed Description

Path 3D model class.

Inheritance diagram for FBModelPath3D:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  __init__ (str pName, object pObject=None)
  Constructor.
  ShowCurveControls (bool pShow)
  ShowCurvePoints (bool pShow)
int  PathKeyGetCount ()
FBVector4  PathKeyGet (int pKeyIndex)
  PathKeySet (int pKeyIndex, FBVector4 pTLocal, bool pUpdate=True)
  PathSetKeyLeftRightTangeant (int pKeyIndex, FBVector4 pKeyTLocal, FBVector4 pLeftTangentTLocal, FBVector4 pRightTangentTLocal, bool pUpdate=True)
  Set Path 3D's Key, Key Left Tangent and Key Right Tangent for designated index at a time.
  PathKeyRemove (int pKeyIndex)
  PathKeyClear ()
  PathKeySetLeftTangeant (int pKeyIndex, FBVector4 pTLocal, bool pUpdate=True)
  PathKeySetRightTangeant (int pKeyIndex, FBVector4 pTLocal, bool pUpdate=True)
FBVector4  PathKeyGetLeftTangeant (int pKeyIndex)
FBVector4  PathKeyGetRightTangeant (int pKeyIndex)
  PathKeySetXDerivative (int pKeyIndex, float pDerivative, bool pUpdate)
  PathKeySetYDerivative (int pKeyIndex, float pDerivative, bool pUpdate)
  PathKeySetZDerivative (int pKeyIndex, float pDerivative, bool pUpdate)
  PathKeySetXYZDerivative (int pKeyIndex, FBVector4 pDerivative, bool pUpdate)
FBVector4  PathKeyGetXYZDerivative (int pKeyIndex)
float  PatKeyGetLeftTangeantLength (int pKeyIndex)
float  PatKeyGetRightTangeantLength (int pKeyIndex)
int  GetSelectedPathKeyCount ()
  PathKeyRemoveSelected ()
int  InsertNewStartKey ()
int  InsertNewEndKey ()
int  PathKeyStartAdd (FBVector4 pTLocal)
int  PathKeyEndAdd (FBVector4 pTLocal)
int  Total_PathKeyAdd (float pTotalPercent, FBVector4 pTLocal)
int  Total_IsPathKey (float pTotalPercent)
FBVector4  Total_GlobalPathEvaluate (float pTotalPercent)
FBVector4  Total_LocalPathEvaluate (float pTotalPercent)
FBVector4  Total_GlobalPathEvaluateDerivative (float pTotalPercent)
FBVector4  Total_LocalPathEvaluateDerivative (float pTotalPercent)
int  Segment_PathKeyAdd (float pSegmentPercent, FBVector4 pTLocal)
int  Segment_IsPathKey (float pSegmentPercent)
FBVector4  Segment_GlobalPathEvaluate (float pSegmentPercent)
FBVector4  Segment_LocalPathEvaluate (float pSegmentPercent)
FBVector4  Segment_GlobalPathEvaluateDerivative (float pSegmentPercent)
FBVector4  Segment_LocalPathEvaluateDerivative (float pSegmentPercent)
float  ConvertTotalPercentToSegmentPercent (float pPercent)
float  ConvertSegmentPercentToTotalPercent (float pPercent)
float  ConvertToSegmentPercentFactor ()
float  ConvertToTotalPercentFactor ()
bool  SetRightTangeantMode (int pKeyIndex, FBPathTangeantMode pTangeantMode)
bool  SetLeftTangeantMode (int pKeyIndex, FBPathTangeantMode pTangeantMode)
FBPathTangeantMode  GetRightTangeantMode (int pKeyIndex)
FBPathTangeantMode  GetLeftTangeantMode (int pKeyIndex)
  UpdateGeometry ()
  Update Path 3D geometry explicitly.

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)

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 = temp.Total_LocalPathEvaluateDerivative(1)
        tgMode = path.GetLeftTangeantMode(0)
        temp.PathKeySetLeftTangeant(1,FBVector4d(25,25,25,25),True)
        ## Ajouter un Vertex
        temp.PathKeyStartAdd(FBVector4d(0,0,100,0))
        temp.PathKeyEndAdd(FBVector4d(100,0,0,0))
        ## Creer Vertex
        temp.Segment_PathKeyAdd(75.0,FBVector4d(25,25,25,25))
        temp.Segment_PathKeyAdd(25.0,FBVector4d(25,0,25,25))

Reimplemented from FBModel.

ShowCurveControls ( bool  pShow )
ShowCurvePoints ( bool  pShow )
int PathKeyGetCount ( )
FBVector4 PathKeyGet ( int  pKeyIndex )
PathKeySet ( int  pKeyIndex,
FBVector4  pTLocal,
bool  pUpdate = True 
)
PathSetKeyLeftRightTangeant ( int  pKeyIndex,
FBVector4  pKeyTLocal,
FBVector4  pLeftTangentTLocal,
FBVector4  pRightTangentTLocal,
bool  pUpdate = True 
)

Set Path 3D's Key, Key Left Tangent and Key Right Tangent for designated index at a time.

Parameters:
pKeyIndex Key ID to set with
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 )
PathKeyClear ( )
PathKeySetLeftTangeant ( int  pKeyIndex,
FBVector4  pTLocal,
bool  pUpdate = True 
)
PathKeySetRightTangeant ( int  pKeyIndex,
FBVector4  pTLocal,
bool  pUpdate = True 
)
FBVector4 PathKeyGetLeftTangeant ( int  pKeyIndex )
FBVector4 PathKeyGetRightTangeant ( int  pKeyIndex )
PathKeySetXDerivative ( int  pKeyIndex,
float  pDerivative,
bool  pUpdate 
)
PathKeySetYDerivative ( int  pKeyIndex,
float  pDerivative,
bool  pUpdate 
)
PathKeySetZDerivative ( int  pKeyIndex,
float  pDerivative,
bool  pUpdate 
)
PathKeySetXYZDerivative ( int  pKeyIndex,
FBVector4  pDerivative,
bool  pUpdate 
)
FBVector4 PathKeyGetXYZDerivative ( int  pKeyIndex )
float PatKeyGetLeftTangeantLength ( int  pKeyIndex )
float PatKeyGetRightTangeantLength ( int  pKeyIndex )
int GetSelectedPathKeyCount ( )
PathKeyRemoveSelected ( )
int InsertNewStartKey ( )
int InsertNewEndKey ( )
int PathKeyStartAdd ( FBVector4  pTLocal )
int PathKeyEndAdd ( FBVector4  pTLocal )
int Total_PathKeyAdd ( float  pTotalPercent,
FBVector4  pTLocal 
)
int Total_IsPathKey ( float  pTotalPercent )
FBVector4 Total_GlobalPathEvaluate ( float  pTotalPercent )
FBVector4 Total_LocalPathEvaluate ( float  pTotalPercent )
FBVector4 Total_GlobalPathEvaluateDerivative ( float  pTotalPercent )
FBVector4 Total_LocalPathEvaluateDerivative ( float  pTotalPercent )
int Segment_PathKeyAdd ( float  pSegmentPercent,
FBVector4  pTLocal 
)
int Segment_IsPathKey ( float  pSegmentPercent )
FBVector4 Segment_GlobalPathEvaluate ( float  pSegmentPercent )
FBVector4 Segment_LocalPathEvaluate ( float  pSegmentPercent )
FBVector4 Segment_GlobalPathEvaluateDerivative ( float  pSegmentPercent )
FBVector4 Segment_LocalPathEvaluateDerivative ( float  pSegmentPercent )
float ConvertTotalPercentToSegmentPercent ( float  pPercent )
float ConvertSegmentPercentToTotalPercent ( float  pPercent )
float ConvertToSegmentPercentFactor ( )
float ConvertToTotalPercentFactor ( )
bool SetRightTangeantMode ( int  pKeyIndex,
FBPathTangeantMode  pTangeantMode 
)
bool SetLeftTangeantMode ( int  pKeyIndex,
FBPathTangeantMode  pTangeantMode 
)
FBPathTangeantMode GetRightTangeantMode ( int  pKeyIndex )
FBPathTangeantMode GetLeftTangeantMode ( int  pKeyIndex )
UpdateGeometry ( )

Update Path 3D geometry explicitly.


FBModelPath3D FBModelPath3D FBModelPath3D FBModelPath3D FBModelPath3D FBModelPath3D FBModelPath3D FBModelPath3D FBModelPath3D FBModelPath3D
FBModelPath3D FBModelPath3D FBModelPath3D FBModelPath3D FBModelPath3D FBModelPath3D FBModelPath3D FBModelPath3D FBModelPath3D FBModelPath3D