All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATAnalysisBase Class CATSamAxis
CATAnalysisBase.CATSamExplicitRoot
|
+---CATSamAxis
Usage: you must use this class as is. You should never derive it.
public class CATSamAxis
Definition of the axis system information of a collector characteristic.
It defines the axis system orientations for each position, repeat and lamina.
Public member :
int * const PublicWorkPtr
A pointer to a public work area.
Constructor and Destructor Index
- o
CATSamAxis()
- Default constructor.
- o
CATSamAxis(CATSamAxis&)
- Copy constructor.
- o
CATSamAxis(CATSamDimension*)
- Constructs and initializes a CATSamAxis object with an instance of a CATSamDimension.
- o
~CATSamAxis()
- Destructor.
Method Index
- o
AddAxisAngle(int,int,int,int,float)
- Add a angle to the Axis angle in Radians for a Position, a Lamina,
a position in the Lamina and a repeat for the position.
- o
ApplyTransformation(CATMath3x3Matrix&)
- Apply a transformation to the axis.
- o
Dump(CATListValCATUnicodeString*,int,int,int)
- Dumps the contents of the object.
- o
Dump(int,int,int)
- Dumps the contents of the object.
- o
GetAxisAngle(int,int,int,int,float&)
- Get the Axis angle in Radians for a a Position, a Lamina,
a position in the Lamina and a repeat for the position.
- o
GetAxisAngleIndex(int,int,int,int,int&)
- Gets the axis angle index in the AxisAngle array for a Position, a Lamina,
a position in the Lamina and a repeat for the position.
- o
GetAxisIndex(int,int,int,int,int&)
- Gets the axis index in the Axis array for a Position, a Lamina,
a position in the Lamina and a repeat for the position.
- o
GetDefinition(int,int,int,int,CATMathVector&,CATMathVector&,CATMathVector&)
- Get the Definition of the instance of the CATSamAxis object for
a Position, a Lamina, a position in the Lamina and a repeat for the position.
- o
GetDefinition(int,int,int,int,float[3],float[3],float[3])
- Get the Definition of the instance of the CATSamAxis object for
a Position, a Lamina, a position in the Lamina and a repeat for the position.
- o
GetDimensionPtr()
- Internal Use Only.
- o
GetTransformationMatrix(int,int,int,int,CATMath3x3Matrix&,CATBoolean)
- Gets the transformation matrix between the current axis system defined for
a Position, a Lamina, a position in the Lamina and a repeat for the position.
- o
GetTransformationMatrix(int,int,int,int,float[3][3],CATBoolean)
- Gets the transformation matrix between the current axis system defined for
a Position, a Lamina, a position in the Lamina and a repeat for the position.
- o
Initialize(CATSamDimension*)
- Initializes a CATSamAxis object with an instance of a CATSamDimension.
- o
IsAKindOf(CATString&)
- Test the type of the instance.
- o
SetAxisAngle(int,int,int,int,float)
- Set the Axis angle in Radians for a a Position, a Lamina,
a position in the Lamina and a repeat for the position.
- o
SetDefinition(int,int,int,int,CATMathVector&,CATMathVector&,CATMathVector&)
- Set the Definition of the instance ofthe CATSamAxis object for
a Position, a Lamina, a position in the Lamina and a repeat for the position.
- o
SetDefinition(int,int,int,int,float[3],float[3],float[3])
- Set the Definition of the instance ofthe CATSamAxis object for
a Position, a Lamina, a position in the Lamina and a repeat for the position.
- o
SetDefinition(int,int,int,int,float[3],float[3],float[3],CATSamRefFrameType,float[3])
- Sets the definition of the axis for a position and a repeat in the position.
- o
operator =(CATSamAxis&)
- Assignment operator.
Data Member Index
- o
PublicWorkPtr
- A pointer to a public work area.
Constructor and Destructor
o CATSamAxis
-
Default constructor.
o CATSamAxis
-
Copy constructor.
o CATSamAxis
-
Constructs and initializes a CATSamAxis object with an instance of a CATSamDimension.
The instance is initialized with the members NbPosition, NbRepeat, NbLamina and NbSMI of the CATSamDimension object.
- Parameters:
-
- iDimension
- The CATSamDimension instance used to initialize the CATSamAxis.
- See also:
- CATSamDimension
o ~CATSamAxis
public virtual ~CATSamAxis( | ) |
-
Destructor.
Methods
o AddAxisAngle
public HRESULT AddAxisAngle( | int | iPosition, |
| int | iLamina, |
| int | iSMI, |
| int | iRepeat, |
| float | iAxisAngle) |
-
Add a angle to the Axis angle in Radians for a Position, a Lamina,
a position in the Lamina and a repeat for the position.
- Parameters:
-
- iPosition
- The index of the position.
- iLamina
- The index of the lamina.
- iSMI
- The index of the position in the lamina.
- iRepeat
- The index of the repeat for the postion.
- iAxisAngle
- The orientation angle in Radians of the Axis.
o ApplyTransformation
-
Apply a transformation to the axis.
- Parameters:
-
- iTransformation
- the Transformation to Apply.
- See also:
- CATMath3x3Matrix
o Dump
-
Dumps the contents of the object.
- Parameters:
-
- oListOfString
- The List of CATUnicodeString.
- iIndent
- The indentation level (one level represents 3 spaces).
- iRecurse
- The number of recursion levels.
- iLoopSize
- The size of loops.
o Dump
public void Dump( | int | iIndent | = 0, |
| int | iRecurse | = 1, |
| int | iLoopSize | = 10) const |
-
Dumps the contents of the object.
- Parameters:
-
- iIndent
- The indentation level (one level represents 3 spaces).
- iRecurse
- The number of recursion levels.
- iLoopSize
- The size of loops.
o GetAxisAngle
public HRESULT GetAxisAngle( | int | iPosition, |
| int | iLamina, |
| int | iSMI, |
| int | iRepeat, |
| float& | oAxisAngle) const |
-
Get the Axis angle in Radians for a a Position, a Lamina,
a position in the Lamina and a repeat for the position.
- Parameters:
-
- iPosition
- The index of the position.
- iLamina
- The index of the lamina.
- iSMI
- The index of the position in the lamina.
- iRepeat
- The index of the repeat for the postion.
- iAxisAngle
- The orientation angle in Radians of the Axis.
o GetAxisAngleIndex
public HRESULT GetAxisAngleIndex( | int | iPosition, |
| int | iLamina, |
| int | iSMI, |
| int | iRepeat, |
| int& | oAxisAngleIndex) const |
-
Gets the axis angle index in the AxisAngle array for a Position, a Lamina,
a position in the Lamina and a repeat for the position.
- Parameters:
-
- iPosition
- The index of the position.
- iLamina
- The index of the lamina.
- iSMI
- The index of the position in the lamina.
- iRepeat
- The index of the repeat for the postion.
- oAxisAngleIndex
- The axis index.
o GetAxisIndex
public HRESULT GetAxisIndex( | int | iPosition, |
| int | iLamina, |
| int | iSMI, |
| int | iRepeat, |
| int& | oAxisIndex) const |
-
Gets the axis index in the Axis array for a Position, a Lamina,
a position in the Lamina and a repeat for the position.
- Parameters:
-
- iPosition
- The index of the position.
- iLamina
- The index of the lamina.
- iSMI
- The index of the position in the lamina.
- iRepeat
- The index of the repeat for the postion.
- oAxisIndex
- The axis index.
o GetDefinition
-
Get the Definition of the instance of the CATSamAxis object for
a Position, a Lamina, a position in the Lamina and a repeat for the position.
The 3 vectors U,V and W are defined in order to have an orthonormal axis system.
- Parameters:
-
- iPosition
- The index of the position.
- iLamina
- The index of the lamina.
- iSMI
- The index of the position in the lamina.
- iRepeat
- The index of the repeat for the postion.
- iVectorU
- The U vector of the axis.
- iVectorV
- The V vector of the axis.
- iVectorW
- The W vector of the axis.
o GetDefinition
public HRESULT GetDefinition( | int | iPosition, |
| int | iLamina, |
| int | iSMI, |
| int | iRepeat, |
| float[3] | oUaxis, |
| float[3] | oVaxis, |
| float[3] | oWaxis) const |
-
Get the Definition of the instance of the CATSamAxis object for
a Position, a Lamina, a position in the Lamina and a repeat for the position.
The 3 vectors U,V and W are defined in order to have an orthonormal axis system.
- Parameters:
-
- iPosition
- The index of the position.
- iLamina
- The index of the lamina.
- iSMI
- The index of the position in the lamina.
- iRepeat
- The index of the repeat for the postion.
- oUaxis[3]
- The coordinates of the U vector of the axis.
- oVaxis[3]
- The coordinates of the V vector of the axis.
- oWaxis[3]
- The coordinates of the W vector of the axis.
o GetDimensionPtr
-
Internal Use Only....
o GetTransformationMatrix
-
Gets the transformation matrix between the current axis system defined for
a Position, a Lamina, a position in the Lamina and a repeat for the position.to the global axis.
- Parameters:
-
- iPosition
- The index of the position.
- iLamina
- The index of the lamina.
- iSMI
- The index of the position in the lamina.
- iRepeat
- The index of the repeat for the postion.
- oTransformationMatrix
- The Transformation matrix.
- iTranspose
- A flag to compute the reverse transformation.
o GetTransformationMatrix
public HRESULT GetTransformationMatrix( | int | iPosition, |
| int | iLamina, |
| int | iSMI, |
| int | iRepeat, |
| float[3][3] | oTransformationMatrix, |
| CATBoolean | iTranspose | = FALSE) const |
-
Gets the transformation matrix between the current axis system defined for
a Position, a Lamina, a position in the Lamina and a repeat for the position.to the global axis.
- Parameters:
-
- iPosition
- The index of the position.
- iLamina
- The index of the lamina.
- iSMI
- The index of the position in the lamina.
- iRepeat
- The index of the repeat for the postion.
- oTransformationMatrix[3][3]
- The Transformation matrix.
- iTranspose
- A flag to compute the reverse transformation.
o Initialize
-
Initializes a CATSamAxis object with an instance of a CATSamDimension.
The instance is initialized with the members NbPosition, NbRepeat, NbLamina and
NbSMI of the CATSamDimension object.
- Parameters:
-
- iDimension
- The CATSamDimension instance used to initialize the CATSamAxis.
- See also:
- CATSamDimension
o IsAKindOf
-
Test the type of the instance.
Return True if iType = CATSamAxis
- Parameters:
-
- iType
- The type to test.
o SetAxisAngle
public HRESULT SetAxisAngle( | int | iPosition, |
| int | iLamina, |
| int | iSMI, |
| int | iRepeat, |
| float | iAxisAngle) |
-
Set the Axis angle in Radians for a a Position, a Lamina,
a position in the Lamina and a repeat for the position.
- Parameters:
-
- iPosition
- The index of the position.
- iLamina
- The index of the lamina.
- iSMI
- The index of the position in the lamina.
- iRepeat
- The index of the repeat for the postion.
- iAxisAngle
- The orientation angle in Radians of the Axis.
o SetDefinition
-
Set the Definition of the instance ofthe CATSamAxis object for
a Position, a Lamina, a position in the Lamina and a repeat for the position.
- Parameters:
-
- iPosition
- The index of the position.
- iLamina
- The index of the lamina.
- iSMI
- The index of the position in the lamina.
- iRepeat
- The index of the repeat for the postion.
- iVectorU
- The U vector of the axis.
- iVectorV
- The V vector of the axis.
- iVectorW
- The W vector of the axis.
o SetDefinition
public HRESULT SetDefinition( | int | iPosition, |
| int | iLamina, |
| int | iSMI, |
| int | iRepeat, |
| const float[3] | iUaxis, |
| const float[3] | iVaxis, |
| const float[3] | iWaxis) |
-
Set the Definition of the instance ofthe CATSamAxis object for
a Position, a Lamina, a position in the Lamina and a repeat for the position.
- Parameters:
-
- iPosition
- The index of the position.
- iLamina
- The index of the lamina.
- iSMI
- The index of the position in the lamina.
- iRepeat
- The index of the repeat for the postion.
- iUaxis[3]
- The coordinates of the U vector of the axis.
- iVaxis[3]
- The coordinates of the V vector of the axis.
- iWaxis[3]
- The coordinates of the W vector of the axis.
o SetDefinition
public HRESULT SetDefinition( | int | iPosition, |
| int | iLamina, |
| int | iSMI, |
| int | iRepeat, |
| const float[3] | iOrigin, |
| const float[3] | iPointOnZAxis, |
| const float[3] | iPointOnXoZPlane, |
| CATSamRefFrameType | iRefFrameType, |
| const float[3] | iLocationPoint) |
-
Sets the definition of the axis for a position and a repeat in the position.
The coordinates of the Uaxis, Vaxis and Waxis vectors are computed in order
to have an orthonormal axis system, and the direction of wAxis is equal to
the direction defined by iOrigin and iPointOnZAxis, except in case of CATSamRefFrameType*Spherical.
- Parameters:
-
- iPosition
- The index of the position.
- iLamina
- The index of the lamina.
- iSMI
- The index of the position in the lamina.
- iRepeat
- The index of the repeat for the postion.
- iOrigin[3]
- The coordinates of the origin of the Z axis.
- iPointOnZAxis[3]
- The coordinates of a point of the Z axis.
- iPointOnXoZPlane[3]
- The coordinates of a point of the +X,o,+Z plane.
- iRefFrameType
- The mathematical type of the axis.
- iLocationPoint[3]
- The coordinates of the point where the axis will be computed.
Only used when iRefFrameType = CATSamRefFrameType*Cylindrical or CATSamRefFrameType*Spherical.
- See also:
- CATSamRefFrameType
o operator =
-
Assignment operator.
Data Members
o PublicWorkPtr
public int * const PublicWorkPtr
-
A pointer to a public work area.
This object is included in the file: CATSamAxis.h
If needed, your Imakefile.mk should include the module: CATSAM0Explicit