VisualizationFoundation CAT3DEdgeGP

Usage: you must use this class as is. You should never derive it.


public class CAT3DEdgeGP

Class to create the graphic primitive of a 3D edge.
Role: Representation of an edge on an element, generally an exact solid. The edge shares the data of the two faces it belongs to (in fact, only the vertices of the first face are being used). The adresses of the faces are stored to complete the topological informa- tion on the element. It is designed to be used by the CATSurfacicRep. The edge is a 3d polyline, with chained vertices references.


Constructor and Destructor Index


o CAT3DEdgeGP(void)
Default constructor.
o CAT3DEdgeGP(CAT3DBoundingGP*,CAT3DBoundingGP*,int const*,int)
Constructs a 3D edge graphic primitive from the two faces it belongs to, its vertices indices and their number.

Method Index


o Draw(CATRender&)
Draws the 3D edge.
o Get(CAT3DBoundingGP**,CAT3DBoundingGP**,float**,int**,int*)
o GetReadOnly(CAT3DBoundingGP**,CAT3DBoundingGP**,float const**,int const**,int*)
Retrieves edge's vertices and faces informations.
o GetSize(void)
Gets the edge vertices number.

Constructor and Destructor


o CAT3DEdgeGP
public CAT3DEdgeGP( )
Default constructor.
o CAT3DEdgeGP
public CAT3DEdgeGP( iFace1,
iFace2,
iVerticesIndices,
iNbVertices)
Constructs a 3D edge graphic primitive from the two faces it belongs to, its vertices indices and their number.
Parameters:
iFace1
The first face the edge belongs to. This face shares vertices informations with the edge.
iFace2
The second face the edge belongs to. This face can be set to NULL if doesn't exist.
iVerticesIndices
Edge vertices indices array, taken from the first face. This means that these indices allow to access vertices coordinates only through first face data.
iNbVertices
The number of vertices in the edge.

Methods


o Draw
public virtual Draw( iRender)
Draws the 3D edge.
Parameters:
iRender
The render through which the edge is drawn.
o Get
public Get( oFref1,
oFref2,
oVerticesFref1,
oIndices,
oIndicesSize)
Deprecated:
R216 see GetReadOnly for read access and CAT3DEdgeGPEditHelper for write access
o GetReadOnly
public GetReadOnly( oFref1,
oFref2,
oVerticesFref1,
oIndices,
oIndicesSize)
Retrieves edge's vertices and faces informations.
Role: As this method is designed to return values on its parameters, it has to be called like this :
 CAT3DBoundingGP * fref1, *fref2;
 float const* verticesFref1;
 ...
 GetReadonly(&fref1, &fref2, &verticesFref1, ...);
 

Parameters:
oFref1
Retrieves a pointer to the edge first face.
oFref2
Retrieves a pointer to the edge second face.
oVerticesFref1
Retrieves the first face vertices coordinates array: XYZXYZXYZ... The edge vertices can be retrieved from this array thanks to their indices stored in *oIndices.
oIndices
Retrieves the array of edge vertices indices. These indices allow the the access to vertices coordinates thanks to the *oVerticesFref1 array. For example, to get the edge first vertex coordinates, one must use the *oVerticesFref1 array combined with the *oIndices array, like this : v0.x = (*oVerticesFref1)[(*oIndices)[0]], v0.y = (*oVerticesFref1)[(*oIndices)[0]+1], v0.z = (*oVerticesFref1)[(*oIndices)[0]+2].
oIndicesSize
Retrieves the oIndices array size.
o GetSize
public GetSize( )
Gets the edge vertices number.

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

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.