All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATSchPlatformInterfaces Interface CATISchCompLocation
System.IUnknown
|
+---CATISchCompLocation
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISchCompLocation
Interface to manage the position and orientation of
Schematic component objects.
Role: To query or modify the position and orientation of
a component
Method Index
- o
GetPosition(CATISchGRRComp*,double*)
- Get the current position of the component.
- o
GetRotationAngle(CATISchGRRComp*,double*)
- Get the current rotation angle (from x-axis in radian) of the component.
- o
GetScale(CATISchGRRComp*,double*)
- Get the current scale factor of the component.
- o
GetTransformation2D(CATISchGRRComp*,double*)
- Get the local coordinate reference frame (with respect to absolute
coordinate system) of the component.
- o
SetPosition(CATISchGRRComp*,double[2])
- Set the current position of the component.
- o
SetRotationAngle(CATISchGRRComp*,double)
- Set the current rotation angle (from x-axis in radian) of the component.
- o
SetScale(CATISchGRRComp*,double)
- Set the current scale factor of the component.
- o
SetTransformation2D(CATISchGRRComp*,double[6])
- Set the local coordinate reference frame (with respect to absolute
coordinate system) of the component.
Methods
o GetPosition
-
Get the current position of the component.
- Parameters:
-
- iGRR
- Pointer to the graphical image of the component
- oDb2Position
- The current position of the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetRotationAngle
-
Get the current rotation angle (from x-axis in radian) of the component.
- Parameters:
-
- iGRR
- Pointer to the graphical image of the component
- oDb1RotationAngleInRad
- The current angle of the component in radian.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetScale
-
Get the current scale factor of the component.
- Parameters:
-
- iGRR
- Pointer to the graphical image of the component
- oDb1ScaleFactor
- The current scale factor of the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetTransformation2D
-
Get the local coordinate reference frame (with respect to absolute
coordinate system) of the component.
- Parameters:
-
- iGRR
- Pointer to the graphical image of the component
- oDb6TransMatrix
- An double array of 6 members.
Transformation matrix that defines the local coordinate reference frame
of the component
member 1, 2 - defines the x-axis of the local coordinate reference frame.
member 3, 4 - defines the y-axis of the local coordinate reference frame.
member 5, 6 - defines the origin of the local coordinate reference frame
One can also interpret this as the transformation matrix that would move
the component from the absolute coordinate frame to the current position
and orientation. As such, the member 5,6 define the translational vector
Furthemore, rotation angle and scale factor can be calculated from
member 1 to 4.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetPosition
-
Set the current position of the component.
- Parameters:
-
- iGRR
- Pointer to the graphical image of the component
- iDb2Position
- The position of the component to be set.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetRotationAngle
-
Set the current rotation angle (from x-axis in radian) of the component.
- Parameters:
-
- iGRR
- Pointer to the graphical image of the component
- iDb1RotationAngleInRad
- The rotation angle of the component in radian to be set.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetScale
-
Set the current scale factor of the component.
- Parameters:
-
- iGRR
- Pointer to the graphical image of the component
- iDb1ScaleFactor
- The scale factor of the component to be set.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetTransformation2D
-
Set the local coordinate reference frame (with respect to absolute
coordinate system) of the component.
- Parameters:
-
- iGRR
- Pointer to the graphical image of the component
- iDb6TransMatrix
- Transformation matrix to be set.
See
GetTransformation2D for explanation of this argument.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATISchCompLocation.h