OdGiVertexData Class Reference

#include <GiGeometry.h>

Inheritance diagram for OdGiVertexData:

Public Types
enum	MapChannel { kAllChannels = 0 }

Public Member Functions
	OdGiVertexData ()
void	setNormals (const OdGeVector3d *normals)
void	setOrientationFlag (const OdGiOrientationType orientationType)
void	setTrueColors (const OdCmEntityColor *colors)
void	setMappingCoords (MapChannel channel, const OdGePoint3d *coords)
const OdGeVector3d *	normals () const
OdGiOrientationType	orientationFlag () const
const OdCmEntityColor *	trueColors () const
const OdGePoint3d *	mappingCoords (MapChannel channel) const

Detailed Description

This class contains arrays of vertex attributes for meshes and shells.

Remarks

VertexData objects are optional; they can be optionally passed to OdGiWorldGeometry and OdGiViewportGeometry when using their mesh and shell methods.

Setting an 'improper' size of any array will cause unpredictable or fatal results.

See also

TD_Gi

<group OdGi_Classes>

Definition at line 720 of file GiGeometry.h.

Member Enumeration Documentation

MapChannel

enum OdGiVertexData::MapChannel

Represents types of map channels.

Enumerator
kAllChannels	All channels.

Definition at line 740 of file GiGeometry.h.

Constructor & Destructor Documentation

OdGiVertexData()

OdGiVertexData::OdGiVertexData ( )

inline

Default constructor for the OdGiVertexData class. Sets normals, colors and mapping coordinates to NULL and the orientation flag to kOdGiNoOrientation.

Definition at line 730 of file GiGeometry.h.

Member Function Documentation

mappingCoords()

const OdGePoint3d * OdGiVertexData::mappingCoords ( MapChannel channel ) const

inline

Returns the array of mapping coordinates used by this object.

Parameters

channel

[in] Specifies mapping channel.

Returns

pointer to an array of mapping coordinates.

Remarks

This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. Writing beyond the array bounds will have unpredictable or fatal consequences.

See also

<link tv_working_with_attributes_materials_mapping, Work with Mapping Properties>

Definition at line 857 of file GiGeometry.h.

normals()

const OdGeVector3d * OdGiVertexData::normals ( ) const

inline

Returns the array of vertex normal vectors used by this object.

Returns

pointer to an array of vertex normals.

Remarks

This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 814 of file GiGeometry.h.

orientationFlag()

OdGiOrientationType OdGiVertexData::orientationFlag ( ) const

inline

Returns the direction of the normal at the vertices that is used by this object.

Returns

orientationFlag which can be one of the following:

Value kOdGiCounterClockwise -1 kOdGiNoOrientation 0 kOdGiClockwise 1

Definition at line 829 of file GiGeometry.h.

setMappingCoords()

void OdGiVertexData::setMappingCoords ( MapChannel channel, const OdGePoint3d * coords )

inline

Sets the mapping coordinates to be used by this object.

Parameters

channel	[in] Specifies mapping channel.
coords	[in] Array of OdGePoint3d objects.

Remarks

This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. An incorrect number of elements will have unpredictable or fatal consequences.

See also

<link tv_working_with_attributes_materials_mapping, Work with Mapping Properties>

Definition at line 801 of file GiGeometry.h.

setNormals()

void OdGiVertexData::setNormals ( const OdGeVector3d * normals )

inline

Sets the vertex normal vectors to be used by this object.

Parameters

normals

[in] Array of normal vectors.

Remarks

This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 754 of file GiGeometry.h.

setOrientationFlag()

void OdGiVertexData::setOrientationFlag ( const OdGiOrientationType orientationType )

inline

Sets the orientation type to be used by this object.

Parameters

orientationType

[in] Orientation type.

Remarks

The orientation type defines the positive direction of the normal at the vertices.

orientationType must be one of the following:

Value kOdGiCounterClockwise -1 kOdGiNoOrientation 0 kOdGiClockwise 1

Definition at line 774 of file GiGeometry.h.

setTrueColors()

void OdGiVertexData::setTrueColors ( const OdCmEntityColor * colors )

inline

Sets the vertex colors to be used by this object.

Parameters

colors

[in] Array of OdCmEntityColor objects.

Remarks

This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. An incorrect number of elements will have unpredictable or fatal consequences.

See also

<exref target="https://docs.opendesign.com/td/cm.html">Working with Colors</exref>

Definition at line 787 of file GiGeometry.h.

trueColors()

const OdCmEntityColor * OdGiVertexData::trueColors ( ) const

inline

Returns the array of vertex colors used by this object.

Returns

pointer to an array of vertex colors.

Remarks

This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. Writing beyond the array bounds will have unpredictable or fatal consequences.

See also

<exref target="https://docs.opendesign.com/td/cm.html">Working with Colors</exref>

Definition at line 842 of file GiGeometry.h.

---

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

• GiGeometry.h