All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

NewTopologicalObjects Interface CATWire

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---GeometricObjects.CATICGMUnknown
        |
        +---GeometricObjects.CATICGMObject
          |
          +---GeometricObjects.CATGeometry
            |
            +---NewTopologicalObjects.CATTopology
              |
              +---NewTopologicalObjects.CATDomain
                |
                +---NewTopologicalObjects.CATEdgeDomain
                  |
                  +---CATWire
 

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


interface CATWire

Interface representing a set connected edges of a body or a volume.

A CATWire is created with the CATBody.CreateWire or CATBody.CreateDomain methods and deleted with the CATICGMContainer.Remove method.


Method Index


o ChangeClosureVertex(CATVertex*)
Changes the first vertex of this CATWire, if it is closed.
o GetExtremities(CATVertex**,CATVertex**,CATMathVector*,CATMathVector*)
Retrieves the extremities of this CATWire.
o GetVertex(int)
Retrieves a vertex of this CATWire.
o GetVertexRank(CATVertex*)
Returns the rank of a vertex in this CATWire.
o IsClosed()
Checks whether the first vertex and the last vertex of this CATWire are the same.

Methods


o ChangeClosureVertex
public virtual void ChangeClosureVertex(CATVertex* iNewClosureVertex) = 0
Changes the first vertex of this CATWire, if it is closed.
Parameters:
iNewClosureVertex
The pointer to the new closure vertex.
o GetExtremities
public virtual void GetExtremities(CATVertex** oStartVertex,
CATVertex** oEndVertex,
CATMathVector* oStartTangent=NULL,
CATMathVector* oEndTangent=NULL) = 0
Retrieves the extremities of this CATWire.
Parameters:
oStartVertex
The pointer to the first vertex of this. If NULL in input, this is not output. If this is closed, a pointer to NULL is returned, and the tangents are not computed.
oEndVertex
The pointer to the last vertex of this. If NULL in input, this is not output. If this is closed, a pointer to NULL is returned, and the tangent are not computed.
oStartTangent
The pointer to the tangent at the first extremity, oriented as the wire. If NULL in input, this is not output.
oEndTangent
The pointer to the tangent at the last extremity, oriented as the wire. If NULL in input, this is not output.
o GetVertex
public virtual CATVertex* GetVertex(int iRank) = 0
Retrieves a vertex of this CATWire.
Parameters:
iRank
The rank of the vertex to retrieve.
Legal values:
0,..,N
If this contains N edges.
0
If this is closed and the vertex is at the closure.
Returns:
The pointer to the corresponding vertex.
o GetVertexRank
public virtual int GetVertexRank(CATVertex* iVertex) = 0
Returns the rank of a vertex in this CATWire.
Parameters:
iVertex
The pointer to the vertex.
Returns:
The corresponding rank.
Legal values:
0,..,N
If this contains N edges.
0
If this is closed and iVertex is at the closure.
-1
If iVertex does not belong to this wire.
o IsClosed
public virtual CATBoolean IsClosed()= 0
Checks whether the first vertex and the last vertex of this CATWire are the same.
Returns:
The result of the test.
Legal values: TRUE if the first and last vertex are the same, FALSE otherwise.

This object is included in the file: CATWire.h
If needed, your Imakefile.mk should include the module: CATTopologicalObjects

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