All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATArrangementInterfaces Interface CATIArrConnectorFactory

System.IUnknown
  |
  +---CATIArrConnectorFactory
 

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


interface CATIArrConnectorFactory

Interface to manage connectors on untyped parts as in the case for SRT, PLO, or SSR Role: To manage connectors on spatial objects.


Method Index


o AddConnector(CATGeometry*,CATArrFaceConnectorTypeEnum&,CATGeometry*,CATArrAlignmentConnectorTypeEnum&,CATGeometry*,CATArrOrientationConnectorTypeEnum&,int&)
Add a new connector with existing geometry data.
o GetAlignmentConnector(int,CATIConnector**,CATArrAlignmentConnectorTypeEnum&)
Returns the alignment connector and its type for a given index.
o GetFaceConnector(int,CATIConnector**,CATArrFaceConnectorTypeEnum&)
Returns the face connector and its type for a given index.
o GetNumberOfConnectors(int&)
Get the number of connectors on this object.
o GetOrientationConnector(int,CATIConnector**,CATArrOrientationConnectorTypeEnum&)
Returns the orientation connector and its type for a given index.
o RemoveConnector(int)
Remove a connector.

Methods


o AddConnector
public virtual HRESULT AddConnector(CATGeometry* iFaceGeom,
const CATArrFaceConnectorTypeEnum& iFaceCntrType,
CATGeometry* iAlignmentGeom,
const CATArrAlignmentConnectorTypeEnum& iAlignmentCntrType,
CATGeometry* iOrientationGeom,
const CATArrOrientationConnectorTypeEnum& iOrientationCntrType,
int& oIndex)= 0
Add a new connector with existing geometry data.
Parameters:
iFaceGeom
The geometry associated with the Face connector. The face where the connector is located.
iFaceCntrType
The face connector type.
iAlignmentGeom
The geometry associated with the Alignment connector. The alignment line that the connector is associated to.
iAlignmentCntrType
The alignment connector type.
iOrientationGeom
The geometry associated with the Orientation connector. The orientation plane that the connector is associated to.
iOrientationCntrType
The orientation connector type.
oIndex
The index of the newly created connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetAlignmentConnector
public virtual HRESULT GetAlignmentConnector( const int iIndex,
CATIConnector** oAlignCntr,
CATArrAlignmentConnectorTypeEnum& oAlignCntrType)= 0
Returns the alignment connector and its type for a given index.
Parameters:
iIndex
The index of the connector for which the alignment connector is to be fetched.
oAlignCntr
[out, CATBaseUnknown#Release] The Alignment connector.
oAlignCntrType
The type associated with that connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetFaceConnector
public virtual HRESULT GetFaceConnector( const int iIndex,
CATIConnector** oFaceCntr,
CATArrFaceConnectorTypeEnum& oFaceCntrType)= 0
Returns the face connector and its type for a given index.
Parameters:
iIndex
The index of the connector for which the face connector is to be fetched.
oFaceCntr
[out, CATBaseUnknown#Release] The face connector.
oFaceCntrTtype
The type associated with that connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetNumberOfConnectors
public virtual HRESULT GetNumberOfConnectors(int& oNumOfCtrs) = 0
Get the number of connectors on this object.
Parameters:
oNumOfCtrs
Number of connectors on object.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetOrientationConnector
public virtual HRESULT GetOrientationConnector( const int iIndex,
CATIConnector** oOrientCntr,
CATArrOrientationConnectorTypeEnum& oOrientCntrType)= 0
Returns the orientation connector and its type for a given index.
Parameters:
iIndex
The index of the connector for which the orientation connector is to be fetched.
oOrientCntr
[out, CATBaseUnknown#Release] The orientation connector.
oOrientCntrType
The type associated with that connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o RemoveConnector
public virtual HRESULT RemoveConnector(int iCtrNumber) = 0
Remove a connector.
Parameters:
iCtrNumber
The connector number of connector to be removed.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIArrConnectorFactory.h

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