CFx SDK Documentation  2023 SP0
Public Member Functions | Public Attributes | List of all members
OdGeShell Class Reference

#include <GeShell.h>

Public Member Functions

 OdGeShell ()
 
void addVertex (const OdGePoint3d &vertex)
 
void endFace ()
 
void startFace (bool bHole=false)
 
void addFaceVertex (int nVertexIndex)
 
void draw (OdGiGeometry &geometry)
 

Public Attributes

OdGePoint3dArray vertices
 
OdInt32Array faces
 
OdUInt16Array edgeColors
 
OdCmEntityColorArray edgeTrueColors
 
OdDbStubPtrArray edgeLayers
 
OdDbStubPtrArray edgeLinetypes
 
OdGsMarkerArray edgeSelectionMarkers
 
OdUInt8Array edgeVisibilities
 
OdUInt16Array faceColors
 
OdCmEntityColorArray faceTrueColors
 
OdDbStubPtrArray faceLayers
 
OdGeVector3dArray faceNormals
 
OdGsMarkerArray faceSelectionMarkers
 
OdUInt8Array faceVisibilities
 
OdDbStubPtrArray faceMaterials
 
OdArray< OdGiMapperfaceMappers
 
OdCmTransparencyArray faceTransparencies
 

Detailed Description

This class represents shell primitives.

Remarks
A shell is a set of faces, defined by a list of shell vertices. Shells can have regular faces and holes and disjoint regions. Shell objects contain vertex data, edge data and face data. Vertex data is defined by one array that is the list of face vertices. Edge data contains arrays of edge properties such as edge color, linetype, visibility etc. Face data is defined by an array of shell faces and arrays of face properties such as face color, normals, transparency, material etc.

Corresponding C++ library: TD_Ge

<group OdGe_Classes>

Definition at line 53 of file GeShell.h.

Constructor & Destructor Documentation

◆ OdGeShell()

OdGeShell::OdGeShell ( )
inline

Definition at line 57 of file GeShell.h.

Member Function Documentation

◆ addFaceVertex()

void OdGeShell::addFaceVertex ( int  nVertexIndex)
inline

Adds a face vertex with a specified index to the face array.

Parameters
nVertexIndex[in] The index from the shell vertices array.

Definition at line 186 of file GeShell.h.

◆ addVertex()

void OdGeShell::addVertex ( const OdGePoint3d vertex)
inline

Adds a vertex to the vertex array of the shell.

Parameters
vertex[in] The vertex to be inserted.

Definition at line 152 of file GeShell.h.

◆ draw()

void OdGeShell::draw ( OdGiGeometry geometry)
inline

Draws the shell using the specified vectorization context.

Parameters
geometry[in] The vectorization context.

Definition at line 197 of file GeShell.h.

◆ endFace()

void OdGeShell::endFace ( )
inline

Ends face assembling. Writes the number of face vertices that have been added by the addFaceVertex() method.

Definition at line 160 of file GeShell.h.

◆ startFace()

void OdGeShell::startFace ( bool  bHole = false)
inline

Starts face assembling. Sets the face index at the start position of a new face to be added and reserves place for the number of face vertices adding -1 or 1 values: -1 if a hole face is expected and 1 for a regular face.

Parameters
bHole[in] Indicates if a hole or regular face is expected. It's false by default.

Definition at line 174 of file GeShell.h.

Member Data Documentation

◆ edgeColors

OdUInt16Array OdGeShell::edgeColors

An array of edges colors.

Definition at line 75 of file GeShell.h.

◆ edgeLayers

OdDbStubPtrArray OdGeShell::edgeLayers

An array of edges layers.

Definition at line 85 of file GeShell.h.

◆ edgeLinetypes

OdDbStubPtrArray OdGeShell::edgeLinetypes

An array of edges linetypes.

Definition at line 90 of file GeShell.h.

◆ edgeSelectionMarkers

OdGsMarkerArray OdGeShell::edgeSelectionMarkers

An array of edges selection markers.

Definition at line 95 of file GeShell.h.

◆ edgeTrueColors

OdCmEntityColorArray OdGeShell::edgeTrueColors

An array of edges true colors.

Definition at line 80 of file GeShell.h.

◆ edgeVisibilities

OdUInt8Array OdGeShell::edgeVisibilities

An array of edges visibilities.

Definition at line 100 of file GeShell.h.

◆ faceColors

OdUInt16Array OdGeShell::faceColors

An array of faces colors.

Definition at line 105 of file GeShell.h.

◆ faceLayers

OdDbStubPtrArray OdGeShell::faceLayers

An array of faces layers.

Definition at line 115 of file GeShell.h.

◆ faceMappers

OdArray<OdGiMapper> OdGeShell::faceMappers

An array of faces mappers.

Definition at line 140 of file GeShell.h.

◆ faceMaterials

OdDbStubPtrArray OdGeShell::faceMaterials

An array of faces materials.

Definition at line 135 of file GeShell.h.

◆ faceNormals

OdGeVector3dArray OdGeShell::faceNormals

An array of faces normal vectors.

Definition at line 120 of file GeShell.h.

◆ faces

OdInt32Array OdGeShell::faces

An array of integer number that defines a list of shell faces. In a face list a particular face is defined be a set of number. The first number contains the number of vertices of the face and its sign indicates if the face is a hole or a regular face: if the face is a hole then its vertices number must be negative. A hole face must be coplanar and entirely in another face (not touching edges). For example, the face array {3,0,2,4,-3,1,0,5} represents two faces. The first is a regular face that consists of three vertices: vertex 0, vertex 2, and vertex 4. The second is the hole face having three vertices: vertex 1, vertex 0, and vertex 5.

Definition at line 70 of file GeShell.h.

◆ faceSelectionMarkers

OdGsMarkerArray OdGeShell::faceSelectionMarkers

An array of faces selection markers.

Definition at line 125 of file GeShell.h.

◆ faceTransparencies

OdCmTransparencyArray OdGeShell::faceTransparencies

An array of faces transparencies.

Definition at line 145 of file GeShell.h.

◆ faceTrueColors

OdCmEntityColorArray OdGeShell::faceTrueColors

An array of faces true colors.

Definition at line 110 of file GeShell.h.

◆ faceVisibilities

OdUInt8Array OdGeShell::faceVisibilities

An array of faces visibilities.

Definition at line 130 of file GeShell.h.

◆ vertices

OdGePoint3dArray OdGeShell::vertices

An array of vertices that are used to construct faces of the shell.

Definition at line 62 of file GeShell.h.


The documentation for this class was generated from the following file: