All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

FittingInterfaces Interface CATITrack

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---FittingInterfaces.CATISampled
        |
        +---CATITrack
 

Usage: you must use this class as is. You should never derive it.


interface CATITrack

Definition of the CATITrack object.
A track defines the motion of an object along a trajectory. Some key characteristics with tracks are:


Method Index


o GetCurrentPosition(CATMathTransformation&)
Retrieves the current position of the object along the track.
o GetCurrentPosition(CATSiFiPosition&)
Retrieves the current position of the object along the track.
o GetFirstPosition(CATMathTransformation&)
Retrieves the track's First Position.
o GetGlobalTransfo(CATMathTransformation&)
Retrieves the track's Global Transformation.
o GetGuaranteedPosition(CATMathTransformation&)
Retrieves the track's Guaranteed Position.
o GetMatrixAll(CATMathTransformation&)
Retrieves the track's Matrix All (base location.
o GetMoveMode(CATFitTrackMoveMode&)
Retrieves the move mode.
o GetSpeed(double&)
Retrieves the speed of the track.
o Mirror(CATMathPoint&,CATMathVector&)
Produces a "mirror image" of the track.
o SetFirstPosition(CATMathTransformation&)
Sets the track's First Position.
o SetGlobalTransfo(CATMathTransformation&)
Sets the track's Global Transformation.
o SetGuaranteedPosition(CATMathTransformation&)
Sets the track's Guaranteed Position.
o SetMatrixAll(CATMathTransformation&)
Sets the track's base location.
o SetMoveMode(CATFitTrackMoveMode)
Sets the move mode.
o SetSpeed(double)
Sets the speed of the track.

Methods


o GetCurrentPosition
public virtual HRESULT GetCurrentPosition(CATMathTransformation& oPosition) =0
Retrieves the current position of the object along the track. Role: Gets the current position of the object along the track. This position is absolute.
Parameters:
oPosition
A transformation for the position
Returns:

S_OK : if the position information was correctly retrieved
E_FAIL : if the position information was not correctly retrieved
o GetCurrentPosition
public virtual HRESULT GetCurrentPosition(CATSiFiPosition& oPosition) =0
Retrieves the current position of the object along the track. Role: Gets the current position of the object along the track. This position is absolute.
Parameters:
oPosition
Information for the position
Returns:

S_OK : if the position information was correctly retrieved
E_FAIL : if the position information was not correctly retrieved
o GetFirstPosition
public virtual HRESULT GetFirstPosition(CATMathTransformation& oFirstPos) =0
Retrieves the track's First Position. Role: The first position is the location of the object the first time the track is created. It is relative to world origin, and once it is set it is stored as part of Matrix All.
Parameters:
iFirstPos
The transformation of the first position of the object.
Returns:

S_OK : if the first postion was correctly retrieved
E_FAIL : if the first position was not correctly retrieved
o GetGlobalTransfo
public virtual HRESULT GetGlobalTransfo(CATMathTransformation& oGlobalTransfo) =0
Retrieves the track's Global Transformation. Role: The global transformation is a transformation applied that affects the global positioning of the track. This is for the case when a track is moved. This transformation is then stored as part of matrix all. It is relative to the world origin.
Parameters:
oGlobalTransfo
The transformation of how much the track has moved.
Returns:

S_OK : if the global transformation was correctly retrieved
E_FAIL : if the global transformation was not correctly retrieved
o GetGuaranteedPosition
public virtual HRESULT GetGuaranteedPosition(CATMathTransformation& oGuaranteedPosition) =0
Retrieves the track's Guaranteed Position. Role: The guaranteed position is a transformation used to move the track relative to the track's starting position (ie. First Position). It is a relative transformation designed to only affect the trajectory information.
Parameters:
oGuaranteedPosition
A transformation relative to the object's first position
Returns:

S_OK : if the guaranteed position was correctly retrieved
E_FAIL : if the guaranteed position was not correctly retrieved
o GetMatrixAll
public virtual HRESULT GetMatrixAll(CATMathTransformation& oAll) =0
Retrieves the track's Matrix All (base location.) Role: Matrix All is defined as the base location of a track. Each shot is then defined relative to this base location. When a track is first created, the value of matrix all is determined from the object that is to be moved.
Returns:

S_OK : if MatrixAll was correctly retrieved
E_FAIL : if MatrixAll was not correctly retrieved
o GetMoveMode
public virtual HRESULT GetMoveMode(CATFitTrackMoveMode& oMode) =0
Retrieves the move mode. Role: There are two different modes related to track creation/definition. These are speed based mode and time based mode.
Parameters:
oMode
The move mode for the track. Legal values:
CATFitSpeedMode for speed based mode
CATFitTimeMode for time based mode
Returns:

S_OK : if the Move Mode value was correctly obtained
E_FAIL : if the Move Mode value was not correctly obtained
o GetSpeed
public virtual HRESULT GetSpeed(double& oSpeed) =0
Retrieves the speed of the track. Role: A track defines the motion of an object along a trajectory. The rate at which the object moves is specified by the speed.
Parameters:
oSpeed
The value of the speed of the track. It should be greater than zero.
Returns:

S_OK : if the Speed value was correctly obtained
E_FAIL : if the Speed Mode value was not correctly obtained
o Mirror
public virtual HRESULT Mirror(CATMathPoint& iPoint,
CATMathVector& iNormal) =0
Produces a "mirror image" of the track. Role: Determines the "mirror image" of a track. The "mirror" is a 3d plane specified by a point on the plane and the normal to the surface of the plane. The mirror calculation involves going through each shot and projecting it in the space on the other side of the mirror plane. The projection "reflects" the point perpendicularly to the plane.
Parameters:
iPoint
A point on the plane that will be used to define the mirror.
iNormal
A normal to the plane that will be used to define the mirror.
Returns:

S_OK : if the mirror function was performed correctly
E_FAIL : if the mirror function was not performed correctly
o SetFirstPosition
public virtual HRESULT SetFirstPosition(CATMathTransformation& iFirstPos) =0
Sets the track's First Position. Role: The first position is the location of the object the first time the track is created. It is relative to world origin, and once it is set it is stored as part of Matrix All.
Parameters:
iFirstPos
The transformation of the first position of the object.
Returns:

S_OK : if the first position was correctly set
E_FAIL : if the first position was not correctly set
o SetGlobalTransfo
public virtual HRESULT SetGlobalTransfo(CATMathTransformation& iGlobalTransfo) =0
Sets the track's Global Transformation. Role: The global transformation is a transformation applied that affects the global position of the track. This is for the case when a track is moved. This transformation is then stored as part of Matrix All. It is relative to the world origin.
Parameters:
iGlobalTransfo
A transformation that will affect the track on a global basis.
Returns:

S_OK : if the global transformation was correctly set
E_FAIL : if the global transformation was not correctly set
o SetGuaranteedPosition
public virtual HRESULT SetGuaranteedPosition(CATMathTransformation& iGuaranteedPosition) =0
Sets the track's Guaranteed Position. Role: The guaranteed position is a transformation used to move the track relative to the track's starting position (ie. First Position). It is a relative transformation designed to only affect the trajectory information.
Parameters:
iGuaranteedPosition
A transformation relative to the object's first position
Returns:

S_OK : if the guaranteed position was correctly set
E_FAIL : if the guaranteed position was not correctly set
o SetMatrixAll
public virtual HRESULT SetMatrixAll(CATMathTransformation& iAll) =0
Sets the track's base location. Role: Matrix All is defined as the base location of a track. Each shot is then defined relative to this base location. When a track is first created, the value of Matrix All is determined from the object that is to be moved.
Returns:

S_OK : if MatrixAll was correctly set
E_FAIL : if MatrixAll was not correctly set
o SetMoveMode
public virtual HRESULT SetMoveMode(CATFitTrackMoveMode iMode) =0
Sets the move mode. Role: There are two different modes related to track creation/ definition. These are speed based mode and time based mode.
Parameters:
iMode
The move mode for the track. Possible returned values:
CATFitSpeedMode for speed based mode
CATFitTimeMode for time based mode
Returns:

S_OK : if the Move Mode value was correctly set
E_FAIL : if the Move Mode value was not correctly set
o SetSpeed
public virtual HRESULT SetSpeed(double iSpeed) =0
Sets the speed of the track. Role: A track defines the motion of an object along a trajectory. The rate at which the object moves is specified by the speed.
Parameters:
iSpeed
The value of the speed of the track. It should be greater than zero
Returns:

S_OK : if the Speed value was correctly set
E_FAIL : if the Speed Mode value was not correctly set

This object is included in the file: CATITrack.h
If needed, your Imakefile.mk should include the module: CATFittingInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.