#include <GiGeometry.h>

Inheritance diagram for OdGiFaceData:

Public Member Functions
	OdGiFaceData ()

void	setColors (const OdUInt16 *colors)

void	setTrueColors (const OdCmEntityColor *colors)

void	setLayers (OdDbStub **layerIds)

void	setSelectionMarkers (const OdGsMarker *selectionMarkers)

void	setNormals (const OdGeVector3d *normals)

void	setVisibility (const OdUInt8 *visibilities)

void	setMaterials (OdDbStub **materialIds)

void	setMappers (const OdGiMapper *mappers)

void	setTransparency (const OdCmTransparency *transparencies)

void	setFillOrigins (const OdGePoint2d *fillOrigins)

void	setFillDirections (const OdGeVector2d *fillDirections)

void	setFillOffsetDirections (const OdGeVector2d *fillOffsetDirections)

void	setFillOffsetScales (const double *fillOffsetScales)

void	setFillDashesScales (const double *fillDashesScales)

const OdUInt16 *	colors () const

const OdCmEntityColor *	trueColors () const

OdDbStub **	layerIds () const

const OdGsMarker *	selectionMarkers () const

const OdGeVector3d *	normals () const

const OdUInt8 *	visibility () const

OdDbStub **	materials () const

const OdGiMapper *	mappers () const

const OdCmTransparency *	transparency () const

const OdGePoint2d *	fillOrigins () const

const OdGeVector2d *	fillDirections () const

const OdGeVector2d *	fillOffsetDirections () const

const double *	fillDashesScales () const

const double *	fillOffsetScales () const

Detailed Description

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

See also: TD_Gi

Definition at line 277 of file GiGeometry.h.

Constructor & Destructor Documentation

◆ OdGiFaceData()

OdGiFaceData::OdGiFaceData ( )

inline

Default constructor for the OdGiFaceData class. Sets current color index, true color, layer and linetype identifiers, selection markers, visibility objects, normals, material identifiers, mappers, transparency objects, fill origins and directions to NULL.

Definition at line 299 of file GiGeometry.h.

Member Function Documentation

◆ colors()

const OdUInt16 * OdGiFaceData::colors ( ) const

inline

Returns the array of face colors used by this object.

Returns: pointer to face color indices.

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 518 of file GiGeometry.h.

◆ fillDashesScales()

const double * OdGiFaceData::fillDashesScales ( ) const

inline

Returns the array of fill dashes scales used by this object. BIM-specific.

Returns: pointer to face fill dashes scales.

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 multiplied by number of pattern lines. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 679 of file GiGeometry.h.

◆ fillDirections()

const OdGeVector2d * OdGiFaceData::fillDirections ( ) const

inline

Returns the array of fill direction vectors used by this object. BIM-specific.

Returns: pointer to face fill directions.

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 multiplied by number of pattern lines. Writing beyond the array bounds will have unpredictable or fatal consequences.

See also: <link tv_working_with_attributes_fill_patterns, Work with Fill Patterns>

Definition at line 655 of file GiGeometry.h.

◆ fillOffsetDirections()

const OdGeVector2d * OdGiFaceData::fillOffsetDirections ( ) const

inline

Returns the array of fill offset vectors used by this object. BIM-specific.

Returns: pointer to face fill offset directions.

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 multiplied by number of pattern lines. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 667 of file GiGeometry.h.

◆ fillOffsetScales()

const double * OdGiFaceData::fillOffsetScales ( ) const

inline

Returns the array of fill offset scales used by this object. BIM-specific.

Returns: pointer to face fill offset scales.

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 multiplied by number of pattern lines. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 691 of file GiGeometry.h.

◆ fillOrigins()

const OdGePoint2d * OdGiFaceData::fillOrigins ( ) const

inline

Returns the array of fill origin points used by this object. BIM-specific.

Returns: pointer to face fill origin points.

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 multiplied by number of pattern lines. Writing beyond the array bounds will have unpredictable or fatal consequences.

See also: <link tv_working_with_attributes_fill_patterns, Work with Fill Patterns>

Definition at line 641 of file GiGeometry.h.

◆ layerIds()

OdDbStub ** OdGiFaceData::layerIds ( ) const

inline

Returns the array of face LayerTableRecord Object IDs used by this object.

Returns: pointer to layer identifiers.

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_layers, Work with Layers>

Definition at line 544 of file GiGeometry.h.

◆ mappers()

const OdGiMapper * OdGiFaceData::mappers ( ) const

inline

Returns the array of face material mappers used by this object.

Returns: pointer to face material mappers.

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 612 of file GiGeometry.h.

◆ materials()

OdDbStub ** OdGiFaceData::materials ( ) const

inline

Returns the array of face material object IDs used by this object.

Returns: pointer to face materials.

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, Work with Materials>

Definition at line 599 of file GiGeometry.h.

◆ normals()

const OdGeVector3d * OdGiFaceData::normals ( ) const

inline

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

Returns: pointer to face 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 566 of file GiGeometry.h.

◆ selectionMarkers()

const OdGsMarker * OdGiFaceData::selectionMarkers ( ) const

inline

Returns the array of face graphics system selection markers used by this object.

Returns: pointer to selection markers.

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 555 of file GiGeometry.h.

◆ setColors()

void OdGiFaceData::setColors ( const OdUInt16 * colors )

inline

Sets the face colors to be used by this object.

Parameters

colors [in] Array of color indices.

Remarks: You cannot call both setColors() and setTrueColors(). 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 328 of file GiGeometry.h.

◆ setFillDashesScales()

void OdGiFaceData::setFillDashesScales ( const double * fillDashesScales )

inline

Sets the face fill dashes scales to be used by this object. BIM-specific.

Parameters

fillDashesScales [in] Array of fill dashes scale parameters.

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 multiplied by number of pattern lines. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 504 of file GiGeometry.h.

◆ setFillDirections()

void OdGiFaceData::setFillDirections ( const OdGeVector2d * fillDirections )

inline

Sets the face fill direction vectors to be used by this object. BIM-specific.

Parameters

fillDirections [in] Array of fill direction 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 multiplied by number of pattern lines. An incorrect number of elements will have unpredictable or fatal consequences.

See also: <link tv_working_with_attributes_fill_patterns, Work with Fill Patterns>

Definition at line 468 of file GiGeometry.h.

◆ setFillOffsetDirections()

void OdGiFaceData::setFillOffsetDirections ( const OdGeVector2d * fillOffsetDirections )

inline

Sets the face fill offset vectors to be used by this object. BIM-specific.

Parameters

fillOffsetDirections [in] Array of fill offset 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 multiplied by number of pattern lines. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 480 of file GiGeometry.h.

◆ setFillOffsetScales()

void OdGiFaceData::setFillOffsetScales ( const double * fillOffsetScales )

inline

Sets the face fill offset scales to be used by this object. BIM-specific.

Parameters

fillOffsetScales [in] Array of fill offset scale parameters.

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 multiplied by number of pattern lines. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 492 of file GiGeometry.h.

◆ setFillOrigins()

void OdGiFaceData::setFillOrigins ( const OdGePoint2d * fillOrigins )

inline

Sets the face fill origin points to be used by this object. BIM-specific.

Parameters

fillOrigins [in] Array of fill origin points.

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 multiplied by number of pattern lines. An incorrect number of elements will have unpredictable or fatal consequences.

See also: <link tv_working_with_attributes_fill_patterns, Work with Fill Patterns>

Definition at line 454 of file GiGeometry.h.

◆ setLayers()

void OdGiFaceData::setLayers ( OdDbStub ** layerIds )

inline

Sets the face Layer Table Records to be used by this object.

Parameters

layerIds [in] Array of LayerTableRecord Object IDs.

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_layers, Work with Layers>

Definition at line 356 of file GiGeometry.h.

◆ setMappers()

void OdGiFaceData::setMappers ( const OdGiMapper * mappers )

inline

Sets the face material mappers to be used by this object.

Parameters

mappers [in] Array of material mappers.

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 425 of file GiGeometry.h.

◆ setMaterials()

void OdGiFaceData::setMaterials ( OdDbStub ** materialIds )

inline

Sets the face material object IDs to be used by this object.

Parameters

materialIds [in] Array of material object IDs.

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, Work with Materials>

Definition at line 411 of file GiGeometry.h.

◆ setNormals()

void OdGiFaceData::setNormals ( const OdGeVector3d * normals )

inline

Sets the face 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 378 of file GiGeometry.h.

◆ setSelectionMarkers()

void OdGiFaceData::setSelectionMarkers ( const OdGsMarker * selectionMarkers )

inline

Sets the face graphics system selection markers to be used by this object.

Parameters

selectionMarkers [in] Array of graphics system selection markers.

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 367 of file GiGeometry.h.

◆ setTransparency()

void OdGiFaceData::setTransparency ( const OdCmTransparency * transparencies )

inline

Sets the face transparency to be used by this object.

Parameters

transparencies [in] Array of OdCmTransparency 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_transparency_alpha.html">Transparency Functionality as an Alpha-value</exref>; <exref target="https://docs.opendesign.com/td/cm_transparency_integer.html">Transparency Functionality as an Integer-value</exref>

Definition at line 440 of file GiGeometry.h.

◆ setTrueColors()

void OdGiFaceData::setTrueColors ( const OdCmEntityColor * colors )

inline

Sets the face colors to be used by this object.

Parameters

colors [in] Array of OdCmEntityColor objects.

Remarks: You cannot call both setColors() and setTrueColors(). 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 343 of file GiGeometry.h.

◆ setVisibility()

void OdGiFaceData::setVisibility ( const OdUInt8 * visibilities )

inline

Sets the face visibilities to be used by this object.

Parameters

visibilities [in] Array of visibility values.

Remarks: Each visibility must be one of the following:

Value Description kOdGiInvisible 0 Invisible kOdGiVisible 1 Visible

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 398 of file GiGeometry.h.

◆ transparency()

const OdCmTransparency * OdGiFaceData::transparency ( ) const

inline

Returns the array of face transparency used by this object.

Returns: pointer to face transparency 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. Writing beyond the array bounds will have unpredictable or fatal consequences.

See also: <exref target="https://docs.opendesign.com/td/cm_transparency_alpha.html">Transparency Functionality as an Alpha-value</exref>; <exref target="https://docs.opendesign.com/td/cm_transparency_integer.html">Transparency Functionality as an Integer-value</exref>

Definition at line 627 of file GiGeometry.h.

◆ trueColors()

const OdCmEntityColor * OdGiFaceData::trueColors ( ) const

inline

Returns the array of face colors used by this object.

Returns: pointer to face 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 531 of file GiGeometry.h.

◆ visibility()

const OdUInt8 * OdGiFaceData::visibility ( ) const

inline

Returns the array of edge visibilities used by this object.

Returns: pointer to visibility values.

Remarks: Each visibility must be one of the following:

Value Description kOdGiInvisible 0 Invisible kOdGiVisible 1 Visible

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 586 of file GiGeometry.h.

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

GiGeometry.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ OdGiFaceData()

Member Function Documentation

◆ colors()

◆ fillDashesScales()

◆ fillDirections()

◆ fillOffsetDirections()

◆ fillOffsetScales()

◆ fillOrigins()

◆ layerIds()

◆ mappers()

◆ materials()

◆ normals()

◆ selectionMarkers()

◆ setColors()

◆ setFillDashesScales()

◆ setFillDirections()

◆ setFillOffsetDirections()

◆ setFillOffsetScales()

◆ setFillOrigins()

◆ setLayers()

◆ setMappers()

◆ setMaterials()

◆ setNormals()

◆ setSelectionMarkers()

◆ setTransparency()

◆ setTrueColors()

◆ setVisibility()

◆ transparency()

◆ trueColors()

◆ visibility()