All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPlantShipInterfaces Interface CATIPspLightConnector

System.IUnknown
  |
  +---CATIPspLightConnector
 

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


interface CATIPspLightConnector

Interface to manage light connectors.
Role: To access light connector data.


Method Index


o GetAlignmentVector(CATIMovable*,CATMathDirection&)
Retrieve the alignment direction of the connector.
o GetOrientationVector(CATIMovable*,CATMathDirection&)
Retrieve the orientation direction of the connector.
o GetOrigin(CATIMovable*,CATMathPoint&)
Retrieve the CATMathPoint of the position of the connector.
o SetAlignmentVector(CATIMovable*,CATMathDirection&)
Set the alignment direction of the connector.
o SetOrientationVector(CATIMovable*,CATMathDirection&)
Set the orientation direction of the connector.
o SetOrigin(CATIMovable*,CATMathPoint&)
Set the position of the connector.

Methods


o GetAlignmentVector
public virtual HRESULT GetAlignmentVector( const CATIMovable* iRelAxis,
CATMathDirection& oAlignmentDirection) = 0
Retrieve the alignment direction of the connector.
Parameters:
iRelAxis
The relative axis object (NULL means relative to parent).
oAlignmentDirection
The align direction as CATMathDirection.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetOrientationVector
public virtual HRESULT GetOrientationVector( const CATIMovable* iRelAxis,
CATMathDirection& oOrientationVectorDirection) = 0
Retrieve the orientation direction of the connector.
Parameters:
iRelAxis
The relative axis object (NULL means relative to parent).
oOrientationDirection
The orientation direction as CATMathDirection.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetOrigin
public virtual HRESULT GetOrigin( const CATIMovable* iRelAxis,
CATMathPoint& oOrigin) = 0
Retrieve the CATMathPoint of the position of the connector.
Parameters:
iRelAxis
The relative axis object (NULL means relative to parent).
oOrigin
The position as CATMathPoint.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetAlignmentVector
public virtual HRESULT SetAlignmentVector( const CATIMovable* iRelAxis,
const CATMathDirection& iAlignmentDirection) = 0
Set the alignment direction of the connector.
Parameters:
iRelAxis
The relative axis object (NULL means relative to parent).
iAlignmentDirection
The alignment direction as CATMathDirection.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetOrientationVector
public virtual HRESULT SetOrientationVector( const CATIMovable* iRelAxis,
const CATMathDirection& iOrientationDirection) = 0
Set the orientation direction of the connector.
Parameters:
iRelAxis
The relative axis object (NULL means relative to parent).
iOrientationDirection
The orientation direction as CATMathDirection.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetOrigin
public virtual HRESULT SetOrigin( const CATIMovable* iRelAxis,
const CATMathPoint& iOrigin) = 0
Set the position of the connector.
Parameters:
iRelAxis
The relative axis object (NULL means relative to parent).
iOrigin
The position as CATMathPoint.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIPspLightConnector.h

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