GMModelInterfaces Interface 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 or
methods and deleted with the
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 ChangeClosureVertex( | | iNewClosureVertex) |
-
Changes the first vertex of this CATWire, if it is closed.
- Parameters:
-
- iNewClosureVertex
- The pointer to the new closure vertex.
o GetExtremities
| public virtual GetExtremities( | | oStartVertex, |
| | oEndVertex, |
| | oStartTangent | =NULL, |
| | oEndTangent | =NULL) |
-
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 GetVertex( | | iRank) |
-
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 GetVertexRank( | | iVertex) |
-
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 IsClosed( | ) |
-
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: CATGMModelInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.