All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATSchPlatformInterfaces Interface CATISchGRRComp
System.IUnknown
|
+---CATISchGRRComp
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISchGRRComp
Interface to manage the position and orientation of
Schematic component graphic objects.
Role: To query or modify the position and orientation of
a component graphic
Method Index
- o
GetPosition(double*)
- Get the current position of the component.
- o
GetRotationAngle(double*)
- Get the current rotation angle (from x-axis in radian) of the component.
- o
GetScale(double*)
- Get the current scale factor of the component.
- o
GetTransformation2D(double*)
- Get the local coordinate reference frame (with respect to absolute
coordinate system) of the component.
- o
SetPosition(double[2])
- Set the current position of the component.
- o
SetRotationAngle(double)
- Set the current rotation angle (from x-axis in radian) of the component.
- o
SetScale(double)
- Set the current scale factor of the component.
- o
SetTransformation2D(double[6])
- Set the local coordinate reference frame (with respect to absolute
coordinate system) of the component.
Methods
o GetPosition
public virtual HRESULT GetPosition( | double* | oDb2Position) = 0 |
-
Get the current position of the component.
- Parameters:
-
- oDb2Position
- The current position of the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetRotationAngle
public virtual HRESULT GetRotationAngle( | double* | oDb1RotationAngleInRad) = 0 |
-
Get the current rotation angle (from x-axis in radian) of the component.
- Parameters:
-
- 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
public virtual HRESULT GetScale( | double* | oDb1ScaleFactor) = 0 |
-
Get the current scale factor of the component.
- Parameters:
-
- 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
public virtual HRESULT GetTransformation2D( | double* | oDb6TransMatrix) = 0 |
-
Get the local coordinate reference frame (with respect to absolute
coordinate system) of the component.
- Parameters:
-
- oDb6TransMatrix
- See
CATISchCompLocation.GetTransformation2D for explanation of this argument.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetPosition
public virtual HRESULT SetPosition( | const double[2] | oDb2Position) = 0 |
-
Set the current position of the component.
- Parameters:
-
- 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
public virtual HRESULT SetRotationAngle( | const double | iDb1RotationAngleInRad) = 0 |
-
Set the current rotation angle (from x-axis in radian) of the component.
- Parameters:
-
- 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
public virtual HRESULT SetScale( | const double | iDb1ScaleFactor) = 0 |
-
Set the current scale factor of the component.
- Parameters:
-
- 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
public virtual HRESULT SetTransformation2D( | const double[6] | iDb6TransMatrix) = 0 |
-
Set the local coordinate reference frame (with respect to absolute
coordinate system) of the component.
- Parameters:
-
- iDb6TransMatrix
- Transformation matrix to be set.
See
CATISchCompLocation.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: CATISchGRRComp.h