All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchCntrLocation

System.IUnknown
  |
  +---CATISchCntrLocation
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISchCntrLocation

Interface to manage the position and orientation of Schematic connector objects.
Role: To query or modify the position and orientation of a schematic connector


Method Index


o GetAlignVector(CATISchGRR*,double*)
Get the current alignment vector of the connector.
o GetPosition(CATISchGRR*,double*)
Get the current position of the connector in absolute coordinates.
o GetRelativePosition(double*)
Get the current position of the connector in relative coordinates.
o SetAlignVector(CATISchGRR*,double[2])
Set the current alignment vector of the connector.
o SetPosition(CATISchGRR*,double[2])
Set the current position of the connector in absolute coordinates.
o SetRelativePosition(double[2])
Set the current position of the connector in absolute coordinates.

Methods


o GetAlignVector
public virtual HRESULT GetAlignVector(CATISchGRR* iGRR,
double* oDb2AlignVector) = 0
Get the current alignment vector of the connector.
Parameters:
iGRR
Pointer to the graphical primitive or the graphical image or the graphical primitives of the owner of the connector.
oDb2AlignVector
X-Y component of the current alignment vector of the connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetPosition
public virtual HRESULT GetPosition(CATISchGRR* iGRR,
double* oDb2Position) = 0
Get the current position of the connector in absolute coordinates.
Parameters:
iGRR
Pointer to the graphical primitive or the graphical image or the graphical primitives of the owner of the connector.
oDb2Position
Absolute X-Y coordinates of the current position of the connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetRelativePosition
public virtual HRESULT GetRelativePosition(double* oDb2RelativePosition) = 0
Get the current position of the connector in relative coordinates.
Parameters:
oDb2RelativePosition
relative X-Y coordinates of the current position of the connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetAlignVector
public virtual HRESULT SetAlignVector(CATISchGRR* iGRR,
const double[2] iDb2AlignVector) = 0
Set the current alignment vector of the connector.
Parameters:
iGRR
Pointer to the graphical primitive or the graphical image or the graphical primitives of the owner of the connector.
iDb2AlignVector
X-Y component of the current alignment vector of the connector to be set.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetPosition
public virtual HRESULT SetPosition(CATISchGRR* iGRR,
const double[2] iDb2Position) = 0
Set the current position of the connector in absolute coordinates. All connectors on multi-images are affected because the relative position on connect will be changed accordingly.
Parameters:
iGRR
Pointer to the graphical primitive or the graphical image or the graphical primitives of the owner of the connector..
iDb2Position
absolute X-Y coordinates of the current position of the connector to be set.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetRelativePosition
public virtual HRESULT SetRelativePosition( const double[2] iDb2RelativePosition) = 0
Set the current position of the connector in absolute coordinates.
Parameters:
iDb2RelativePosition
relative X-Y coordinates of the current position of the connector to be set.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchCntrLocation.h

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