#include <hps.h>

Inheritance diagram for HPS::MeshKey:
HPS::GeometryKey HPS::Key HPS::Object

Public Member Functions

void Consume (MeshKit &in_kit)
 
MeshKeyEditMeshByReplacement (size_t in_row_offset, size_t in_column_offset, size_t in_row_count, size_t in_column_count, size_t in_point_count, Point const in_points[])
 
MeshKeyEditMeshByReplacement (size_t in_row_offset, size_t in_column_offset, size_t in_row_count, size_t in_column_count, PointArray const &in_points)
 
size_t GetPointCount () const
 
 MeshKey ()
 
 MeshKey (Key const &in_that)
 
 MeshKey (MeshKey const &in_that)
 
 MeshKey (MeshKey &&in_that)
 
HPS::Type ObjectType () const
 
MeshKeyoperator= (MeshKey const &in_that)
 
MeshKeyoperator= (MeshKey &&in_that)
 
void Set (MeshKit const &in_kit)
 
MeshKeySetEdgeIndexColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, FloatArray const &in_indices)
 
MeshKeySetEdgeIndexColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, float in_index)
 
MeshKeySetEdgeIndexColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], float const in_indices[])
 
MeshKeySetEdgeIndexColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], float in_index)
 
MeshKeySetEdgeRGBColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, RGBColorArray const &in_rgb_colors)
 
MeshKeySetEdgeRGBColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, RGBColor const &in_rgb_color)
 
MeshKeySetEdgeRGBColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], RGBColor const in_rgb_colors[])
 
MeshKeySetEdgeRGBColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], RGBColor const in_rgb_color)
 
MeshKeySetEdgeVisibilitiesByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], bool const in_visibilities[])
 
MeshKeySetEdgeVisibilitiesByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], bool in_visibility)
 
MeshKeySetEdgeVisibilitiesByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, bool in_visibility)
 
MeshKeySetEdgeVisibilitiesByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, BoolArray const &in_visibilities)
 
MeshKeySetFaceIndexColorsByList (size_t in_count, size_t const in_faces[], float const in_indices[])
 
MeshKeySetFaceIndexColorsByList (SizeTArray const &in_faces, FloatArray const &in_indices)
 
MeshKeySetFaceIndexColorsByList (size_t in_count, size_t const in_faces[], float in_index)
 
MeshKeySetFaceIndexColorsByList (SizeTArray const &in_faces, float in_index)
 
MeshKeySetFaceIndexColorsByRange (size_t in_start, size_t in_count, float const in_indices[])
 
MeshKeySetFaceIndexColorsByRange (size_t in_start, FloatArray const &in_indices)
 
MeshKeySetFaceIndexColorsByRange (size_t in_start, size_t in_count, float in_index)
 
MeshKeySetFaceNormalsByList (size_t in_count, size_t const in_faces[], Vector const in_normals[])
 
MeshKeySetFaceNormalsByList (SizeTArray const &in_faces, VectorArray const &in_normals)
 
MeshKeySetFaceNormalsByList (size_t in_count, size_t const in_faces[], Vector const &in_normal)
 
MeshKeySetFaceNormalsByList (SizeTArray const &in_faces, Vector const &in_normal)
 
MeshKeySetFaceNormalsByRange (size_t in_start, size_t in_count, Vector const in_normals[])
 
MeshKeySetFaceNormalsByRange (size_t in_start, VectorArray const &in_normals)
 
MeshKeySetFaceNormalsByRange (size_t in_start, size_t in_count, Vector const &in_normal)
 
MeshKeySetFaceRGBColorsByList (size_t in_count, size_t const in_faces[], RGBColor const in_rgb_colors[])
 
MeshKeySetFaceRGBColorsByList (SizeTArray const &in_faces, RGBColorArray const &in_rgb_colors)
 
MeshKeySetFaceRGBColorsByList (size_t in_count, size_t const in_faces[], RGBColor const &in_rgb_color)
 
MeshKeySetFaceRGBColorsByList (SizeTArray const &in_faces, RGBColor const &in_rgb_color)
 
MeshKeySetFaceRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const in_rgb_colors[])
 
MeshKeySetFaceRGBColorsByRange (size_t in_start, RGBColorArray const &in_rgb_colors)
 
MeshKeySetFaceRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const &in_rgb_color)
 
MeshKeySetFaceVisibilitiesByList (size_t in_count, size_t const in_faces[], bool const in_visibilities[])
 
MeshKeySetFaceVisibilitiesByList (SizeTArray const &in_faces, BoolArray const &in_visibilities)
 
MeshKeySetFaceVisibilitiesByList (size_t in_count, size_t const in_faces[], bool in_visibility)
 
MeshKeySetFaceVisibilitiesByList (SizeTArray const &in_faces, bool in_visibility)
 
MeshKeySetFaceVisibilitiesByRange (size_t in_start, size_t in_count, bool const in_visibilities[])
 
MeshKeySetFaceVisibilitiesByRange (size_t in_start, BoolArray const &in_visibilities)
 
MeshKeySetFaceVisibilitiesByRange (size_t in_start, size_t in_count, bool in_visibility)
 
MeshKeySetMaterialMapping (MaterialMappingKit const &in_kit)
 
MeshKeySetPoints (size_t in_rows, size_t in_columns, PointArray const &in_points)
 
MeshKeySetPoints (size_t in_rows, size_t in_columns, size_t in_count, Point const in_points [])
 
MeshKeySetVertexIndexColorsByList (size_t in_count, size_t const in_vertices[], float const in_indices[], Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexIndexColorsByList (SizeTArray const &in_vertices, FloatArray const &in_indices, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexIndexColorsByList (size_t in_count, size_t const in_vertices[], float in_index, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexIndexColorsByList (SizeTArray const &in_vertices, float in_index, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexIndexColorsByRange (size_t in_start, size_t in_count, float const in_indices[], Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexIndexColorsByRange (size_t in_start, FloatArray const &in_indices, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexIndexColorsByRange (size_t in_start, size_t in_count, float in_index, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexNormalsByList (size_t in_count, size_t const in_vertices[], Vector const in_normals[])
 
MeshKeySetVertexNormalsByList (SizeTArray const &in_vertices, VectorArray const &in_normals)
 
MeshKeySetVertexNormalsByList (size_t in_count, size_t const in_vertices[], Vector const &in_normal)
 
MeshKeySetVertexNormalsByList (SizeTArray const &in_vertices, Vector const &in_normal)
 
MeshKeySetVertexNormalsByRange (size_t in_start, size_t in_count, Vector const in_normals[])
 
MeshKeySetVertexNormalsByRange (size_t in_start, VectorArray const &in_normals)
 
MeshKeySetVertexNormalsByRange (size_t in_start, size_t in_count, Vector const &in_normal)
 
MeshKeySetVertexParametersByList (size_t in_vertex_count, size_t const in_vertices[], size_t in_param_count, float const in_params[], size_t in_param_width=2)
 
MeshKeySetVertexParametersByList (SizeTArray const &in_vertices, FloatArray const &in_params, size_t in_param_width=2)
 
MeshKeySetVertexParametersByRange (size_t in_start, size_t in_param_count, float const in_params[], size_t in_param_width=2)
 
MeshKeySetVertexParametersByRange (size_t in_start, FloatArray const &in_params, size_t in_param_width=2)
 
MeshKeySetVertexRGBAColorsByList (size_t in_count, size_t const in_vertices[], RGBAColor const in_rgba_colors[], Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexRGBAColorsByList (SizeTArray const &in_vertices, RGBAColorArray const &in_rgba_colors, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexRGBAColorsByList (size_t in_count, size_t const in_vertices[], RGBAColor const &in_rgba_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexRGBAColorsByList (SizeTArray const &in_vertices, RGBAColor const &in_rgba_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexRGBAColorsByRange (size_t in_start, size_t in_count, RGBAColor const in_rgba_colors[], Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexRGBAColorsByRange (size_t in_start, RGBAColorArray const &in_rgba_colors, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexRGBAColorsByRange (size_t in_start, size_t in_count, RGBAColor const &in_rgba_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexRGBColorsByList (size_t in_count, size_t const in_vertices[], RGBColor const in_rgb_colors[], Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexRGBColorsByList (SizeTArray const &in_vertices, RGBColorArray const &in_rgb_colors, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexRGBColorsByList (size_t in_count, size_t const in_vertices[], RGBColor const &in_rgb_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexRGBColorsByList (SizeTArray const &in_vertices, RGBColor const &in_rgb_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const in_rgb_colors[], Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexRGBColorsByRange (size_t in_start, RGBColorArray const &in_rgb_colors, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const &in_rgb_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKeySetVertexVisibilitiesByList (size_t in_count, size_t const in_vertices[], bool const in_visibilities[])
 
MeshKeySetVertexVisibilitiesByList (SizeTArray const &in_vertices, BoolArray const &in_visibilities)
 
MeshKeySetVertexVisibilitiesByList (size_t in_count, size_t const in_vertices[], bool in_visibility)
 
MeshKeySetVertexVisibilitiesByList (SizeTArray const &in_vertices, bool in_visibility)
 
MeshKeySetVertexVisibilitiesByRange (size_t in_start, size_t in_count, bool const in_visibilities[])
 
MeshKeySetVertexVisibilitiesByRange (size_t in_start, BoolArray const &in_visibilities)
 
MeshKeySetVertexVisibilitiesByRange (size_t in_start, size_t in_count, bool in_visibility)
 
void Show (MeshKit &out_kit) const
 
bool ShowColumns (size_t &out_columns) const
 
bool ShowEdgeColors (SizeTArray &out_vertices1, SizeTArray &out_vertices2, HPS::MaterialTypeArray &out_types, HPS::RGBColorArray &out_rgb_colors, HPS::FloatArray &out_indices)
 
bool ShowEdgeColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, HPS::MaterialTypeArray &out_types, HPS::RGBColorArray &out_rgb_colors, HPS::FloatArray &out_indices)
 
bool ShowEdgeVisibilitiesByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, BoolArray &out_validities, BoolArray &out_visibilities) const
 
bool ShowFaceColors (MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const
 
bool ShowFaceColorsByList (SizeTArray const &in_faces, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const
 
bool ShowFaceColorsByRange (size_t in_start, size_t in_count, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const
 
bool ShowFaceNormals (BoolArray &out_validities, VectorArray &out_normals) const
 
bool ShowFaceNormalsByList (SizeTArray const &in_faces, BoolArray &out_validities, VectorArray &out_normals) const
 
bool ShowFaceNormalsByRange (size_t in_start, size_t in_count, BoolArray &out_validities, VectorArray &out_normals) const
 
bool ShowFaceVisibilities (BoolArray &out_validities, BoolArray &out_visibilities) const
 
bool ShowFaceVisibilitiesByList (SizeTArray const &in_faces, BoolArray &out_validities, BoolArray &out_visibilities) const
 
bool ShowFaceVisibilitiesByRange (size_t in_start, size_t in_count, BoolArray &out_validities, BoolArray &out_visibilities) const
 
bool ShowMaterialMapping (MaterialMappingKit &out_kit) const
 
bool ShowNetVertexNormals (VectorArray &out_normals, Drawing::Handedness in_polygon_handedness=Drawing::Handedness::None) const
 
bool ShowNetVertexNormalsByRange (size_t in_start, size_t in_count, VectorArray &out_normals, Drawing::Handedness in_polygon_handedness=Drawing::Handedness::None) const
 
bool ShowPoints (PointArray &out_points) const
 
bool ShowPoints (size_t &out_rows, size_t &out_columns, PointArray &out_points) const
 
bool ShowPointsByList (SizeTArray const &in_indices, PointArray &out_points) const
 
bool ShowPointsByList (size_t in_count, size_t const in_indices[], PointArray &out_points) const
 
bool ShowPointsByRange (size_t in_start_index, size_t in_count, PointArray &out_points) const
 
bool ShowRows (size_t &out_rows) const
 
bool ShowVertexColors (Mesh::Component in_apply_to, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, RGBAColorArray &out_rgba_colors, FloatArray &out_indices) const
 
bool ShowVertexColorsByList (SizeTArray const &in_vertices, Mesh::Component in_apply_to, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, RGBAColorArray &out_rgba_colors, FloatArray &out_indices) const
 
bool ShowVertexColorsByRange (size_t in_start, size_t in_count, Mesh::Component in_apply_to, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, RGBAColorArray &out_rgba_colors, FloatArray &out_indices) const
 
bool ShowVertexNormals (BoolArray &out_validities, VectorArray &out_normals) const
 
bool ShowVertexNormalsByList (SizeTArray const &in_vertices, BoolArray &out_validities, VectorArray &out_normals) const
 
bool ShowVertexNormalsByRange (size_t in_start, size_t in_count, BoolArray &out_validities, VectorArray &out_normals) const
 
bool ShowVertexParameters (BoolArray &out_validities, FloatArray &out_params) const
 
bool ShowVertexParameters (BoolArray &out_validities, FloatArray &out_params, size_t &out_param_width) const
 
bool ShowVertexParametersByList (SizeTArray const &in_vertices, BoolArray &out_validities, FloatArray &out_params) const
 
bool ShowVertexParametersByList (SizeTArray const &in_vertices, BoolArray &out_validities, FloatArray &out_params, size_t &out_param_width) const
 
bool ShowVertexParametersByRange (size_t in_start, size_t in_count, BoolArray &out_validities, FloatArray &out_params) const
 
bool ShowVertexParametersByRange (size_t in_start, size_t in_count, BoolArray &out_validities, FloatArray &out_params, size_t &out_param_width) const
 
bool ShowVertexVisibilities (BoolArray &out_validities, BoolArray &out_visibilities) const
 
bool ShowVertexVisibilitiesByList (SizeTArray const &in_vertices, BoolArray &out_validities, BoolArray &out_visibilities) const
 
bool ShowVertexVisibilitiesByRange (size_t in_start, size_t in_count, BoolArray &out_validities, BoolArray &out_visibilities) const
 
MeshKeyUnsetEdgeColors ()
 
MeshKeyUnsetEdgeColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2)
 
MeshKeyUnsetEdgeColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[])
 
MeshKeyUnsetEdgeEverything ()
 
MeshKeyUnsetEdgeVisibilities ()
 
MeshKeyUnsetEdgeVisibilitiesByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2)
 
MeshKeyUnsetEdgeVisibilitiesByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[])
 
MeshKeyUnsetEverything ()
 
MeshKeyUnsetFaceColors ()
 
MeshKeyUnsetFaceColorsByList (SizeTArray const &in_faces)
 
MeshKeyUnsetFaceColorsByList (size_t in_count, size_t const in_faces[])
 
MeshKeyUnsetFaceColorsByRange (size_t in_start, size_t in_count)
 
MeshKeyUnsetFaceEverything ()
 
MeshKeyUnsetFaceNormals ()
 
MeshKeyUnsetFaceNormalsByList (SizeTArray const &in_faces)
 
MeshKeyUnsetFaceNormalsByRange (size_t in_start, size_t in_count)
 
MeshKeyUnsetFaceVisibilities ()
 
MeshKeyUnsetFaceVisibilitiesByList (size_t in_count, size_t const in_faces[])
 
MeshKeyUnsetFaceVisibilitiesByList (SizeTArray const &in_faces)
 
MeshKeyUnsetFaceVisibilitiesByRange (size_t in_start, size_t in_count)
 
MeshKeyUnsetMaterialMapping ()
 
MeshKeyUnsetVertexColors ()
 
MeshKeyUnsetVertexColors (Mesh::Component in_apply_to)
 
MeshKeyUnsetVertexColorsByList (size_t in_count, size_t const in_vertices[])
 
MeshKeyUnsetVertexColorsByList (size_t in_count, size_t const in_vertices[], Mesh::Component in_apply_to)
 
MeshKeyUnsetVertexColorsByList (SizeTArray const &in_vertices)
 
MeshKeyUnsetVertexColorsByList (SizeTArray const &in_vertices, Mesh::Component in_apply_to)
 
MeshKeyUnsetVertexColorsByRange (size_t in_start, size_t in_count)
 
MeshKeyUnsetVertexColorsByRange (size_t in_start, size_t in_count, Mesh::Component in_apply_to)
 
MeshKeyUnsetVertexEverything ()
 
MeshKeyUnsetVertexNormals ()
 
MeshKeyUnsetVertexNormalsByList (SizeTArray const &in_vertices)
 
MeshKeyUnsetVertexNormalsByRange (size_t in_start, size_t in_count)
 
MeshKeyUnsetVertexParameters ()
 
MeshKeyUnsetVertexParametersByList (SizeTArray const &in_vertices)
 
MeshKeyUnsetVertexParametersByRange (size_t in_start, size_t in_count)
 
MeshKeyUnsetVertexVisibilities ()
 
MeshKeyUnsetVertexVisibilitiesByList (size_t in_count, size_t const in_vertices[])
 
MeshKeyUnsetVertexVisibilitiesByList (SizeTArray const &in_vertices)
 
MeshKeyUnsetVertexVisibilitiesByRange (size_t in_start, size_t in_count)
 
- Public Member Functions inherited from HPS::GeometryKey
 GeometryKey ()
 
 GeometryKey (Key const &in_that)
 
 GeometryKey (GeometryKey const &in_that)
 
 GeometryKey (GeometryKey &&in_that)
 
GeometryKeyoperator= (GeometryKey const &in_that)
 
GeometryKeyoperator= (GeometryKey &&in_that)
 
GeometryKeySetPriority (int in_priority)
 
GeometryKeySetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
 
GeometryKeySetUserData (intptr_t in_index, ByteArray const &in_data)
 
GeometryKeySetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
 
bool ShowBounding (BoundingKit &out_kit) const
 
bool ShowPriority (int &out_priority) const
 
size_t ShowReferrers (SegmentKeyArray &out_segments) const
 
size_t ShowReferrers (ReferenceKeyArray &out_references) const
 
bool ShowUserData (intptr_t in_index, ByteArray &out_data) const
 
bool ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const
 
size_t ShowUserDataCount () const
 
bool ShowUserDataIndices (IntPtrTArray &out_indices) const
 
GeometryKeyUnsetAllUserData ()
 
GeometryKeyUnsetPriority ()
 
GeometryKeyUnsetUserData (intptr_t in_index)
 
GeometryKeyUnsetUserData (size_t in_count, intptr_t const in_indices[])
 
GeometryKeyUnsetUserData (IntPtrTArray const &in_indices)
 
- Public Member Functions inherited from HPS::Key
virtual void Assign (Key const &in_that)
 
Key CopyTo (SegmentKey const &in_destination) const
 
void Delete ()
 
bool Equals (Key const &in_that) const
 
size_t GetHash () const
 
bool HasOwner () const
 
 Key ()
 
 Key (Key const &in_that)
 
 Key (Control const &in_control)
 
 Key (Key &&in_that)
 
void MoveTo (SegmentKey const &in_new_owner)
 
bool operator!= (Key const &in_that) const
 
Keyoperator= (Key &&in_that)
 
Keyoperator= (Key const &in_that)
 
bool operator== (Key const &in_that) const
 
SegmentKey Owner () const
 
SegmentKey Up () const
 
virtual ~Key ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::MeshKey
 
- Static Public Attributes inherited from HPS::GeometryKey
static const HPS::Type staticType = HPS::Type::GeometryKey
 
- Static Public Attributes inherited from HPS::Key
static const HPS::Type staticType = HPS::Type::Key
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The MeshKey class is a smart pointer to a database object. It is a handle to a mesh created by SegmentKey::InsertMesh.

Constructor & Destructor Documentation

◆ MeshKey() [1/4]

HPS::MeshKey::MeshKey ( )

The default constructor creates an uninitialized MeshKey object. The Type() function will return Type::None.

◆ MeshKey() [2/4]

HPS::MeshKey::MeshKey ( Key const &  in_that)
explicit

This constructor creates an MeshKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a mesh key. Otherwise the copy will fail and the resulting MeshKey will be invalid.

Parameters
in_thatThe source Key to copy.

◆ MeshKey() [3/4]

HPS::MeshKey::MeshKey ( MeshKey const &  in_that)

The copy constructor creates a MeshKey object that shares the underlying smart-pointer of the source MeshKey.

Parameters
in_thatThe source MeshKey to copy.

◆ MeshKey() [4/4]

HPS::MeshKey::MeshKey ( MeshKey &&  in_that)

The move constructor creates a MeshKey by transferring the underlying impl of the rvalue reference to this MeshKey thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a MeshKey to take the impl from.

Member Function Documentation

◆ Consume()

void HPS::MeshKey::Consume ( MeshKit in_kit)

Completely replaces all settings on this MeshKey with those set on the specified kit and resets the kit.

Parameters
in_kitThe kit from which to get the settings to replace on this MeshKey.

◆ EditMeshByReplacement() [1/2]

MeshKey& HPS::MeshKey::EditMeshByReplacement ( size_t  in_row_offset,
size_t  in_column_offset,
size_t  in_row_count,
size_t  in_column_count,
size_t  in_point_count,
Point const  in_points[] 
)

Replaces a range of points for this MeshKey.

Parameters
in_row_offsetThe row offset into the MeshKey at which to start replacing points. This value must be such that in_row_offset<row_count for replacement to succeed.
in_column_offsetThe column offset into the MeshKey at which to start replacing points. This value must be such that in_column_offset<column_count for replacement to succeed.
in_row_countThe number of rows to replace. This value must be such that in_row_offset+in_row_count<=row_count for replacement to succeed.
in_column_countThe number of columns to replace. This value must be such that in_column_offset+in_column_count<=column_count for replacement to succeed.
in_point_countThe size of the in_points array. The size of the array should be in_row_count*in_column_count.
in_pointsThe points to use to replace those in the specified range.
Returns
A reference to this MeshKey.

◆ EditMeshByReplacement() [2/2]

MeshKey& HPS::MeshKey::EditMeshByReplacement ( size_t  in_row_offset,
size_t  in_column_offset,
size_t  in_row_count,
size_t  in_column_count,
PointArray const &  in_points 
)

Replaces a range of points for this MeshKey.

Parameters
in_row_offsetThe row offset into the MeshKey at which to start replacing points. This value must be such that in_row_offset<row_count for replacement to succeed.
in_column_offsetThe column offset into the MeshKey at which to start replacing points. This value must be such that in_column_offset<column_count for replacement to succeed.
in_row_countThe number of rows to replace. This value must be such that in_row_offset+in_row_count<=row_count for replacement to succeed.
in_column_countThe number of columns to replace. This value must be such that in_column_offset+in_column_count<=column_count for replacement to succeed.
in_pointsThe points to use to replace those in the specified range. The size of the array should be in_row_count*in_column_count.
Returns
A reference to this MeshKey.

◆ GetPointCount()

size_t HPS::MeshKey::GetPointCount ( ) const

Retrieves the number of points in this mesh.

Returns
The number of points in this mesh.

◆ ObjectType()

HPS::Type HPS::MeshKey::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::GeometryKey.

◆ operator=() [1/2]

MeshKey& HPS::MeshKey::operator= ( MeshKey const &  in_that)

Associate this MeshKey with the same underlying impl as the source MeshKey.

Parameters
in_thatThe source MeshKey for the assignment.
Returns
A reference to this MeshKey.

◆ operator=() [2/2]

MeshKey& HPS::MeshKey::operator= ( MeshKey &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this MeshKey thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a MeshKey to take the impl from.
Returns
A reference to this MeshKey.

◆ Set()

void HPS::MeshKey::Set ( MeshKit const &  in_kit)

Replace those settings on this MeshKey with those set on the specified kit.

Parameters
in_kitThe kit from which to get the settings to replace on this MeshKey.

◆ SetEdgeIndexColorsByList() [1/4]

MeshKey& HPS::MeshKey::SetEdgeIndexColorsByList ( SizeTArray const &  in_vertices1,
SizeTArray const &  in_vertices2,
FloatArray const &  in_indices 
)

Sets edge material indices on a selection of arbitrary edges.

Parameters
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_indicesThe material indices to set on the edges.
Returns
A reference to this MeshKey.

◆ SetEdgeIndexColorsByList() [2/4]

MeshKey& HPS::MeshKey::SetEdgeIndexColorsByList ( SizeTArray const &  in_vertices1,
SizeTArray const &  in_vertices2,
float  in_index 
)

Sets edge material indices on a selection of arbitrary edges.

Parameters
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_indexThe material index to set on the edges.
Returns
A reference to this MeshKey.

◆ SetEdgeIndexColorsByList() [3/4]

MeshKey& HPS::MeshKey::SetEdgeIndexColorsByList ( size_t  in_count,
size_t const  in_vertices1[],
size_t const  in_vertices2[],
float const  in_indices[] 
)

Sets edge material indices on a selection of arbitrary edges.

Parameters
in_countSize of the following arrays.
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_indicesThe material indices to set on the edges.
Returns
A reference to this MeshKey.

◆ SetEdgeIndexColorsByList() [4/4]

MeshKey& HPS::MeshKey::SetEdgeIndexColorsByList ( size_t  in_count,
size_t const  in_vertices1[],
size_t const  in_vertices2[],
float  in_index 
)

Sets edge material indices on a selection of arbitrary edges.

Parameters
in_countSize of the following arrays.
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_indexThe material index to set on the edges.
Returns
A reference to this MeshKey.

◆ SetEdgeRGBColorsByList() [1/4]

MeshKey& HPS::MeshKey::SetEdgeRGBColorsByList ( SizeTArray const &  in_vertices1,
SizeTArray const &  in_vertices2,
RGBColorArray const &  in_rgb_colors 
)

Sets edge colors on a selection of arbitrary edges.

Parameters
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgb_colorsThe colors to set on the edges.
Returns
A reference to this MeshKey.

◆ SetEdgeRGBColorsByList() [2/4]

MeshKey& HPS::MeshKey::SetEdgeRGBColorsByList ( SizeTArray const &  in_vertices1,
SizeTArray const &  in_vertices2,
RGBColor const &  in_rgb_color 
)

Sets edge colors on a selection of arbitrary edges.

Parameters
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgb_colorThe color to set on the edges.
Returns
A reference to this MeshKey.

◆ SetEdgeRGBColorsByList() [3/4]

MeshKey& HPS::MeshKey::SetEdgeRGBColorsByList ( size_t  in_count,
size_t const  in_vertices1[],
size_t const  in_vertices2[],
RGBColor const  in_rgb_colors[] 
)

Sets edge colors on a selection of arbitrary edges.

Parameters
in_countSize of the following arrays.
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgb_colorsThe colors to set on the edges.
Returns
A reference to this MeshKey.

◆ SetEdgeRGBColorsByList() [4/4]

MeshKey& HPS::MeshKey::SetEdgeRGBColorsByList ( size_t  in_count,
size_t const  in_vertices1[],
size_t const  in_vertices2[],
RGBColor const  in_rgb_color 
)

Sets edge colors on a selection of arbitrary edges.

Parameters
in_countSize of the following arrays.
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgb_colorThe color to set on the edges.
Returns
A reference to this MeshKey.

◆ SetEdgeVisibilitiesByList() [1/4]

MeshKey& HPS::MeshKey::SetEdgeVisibilitiesByList ( size_t  in_count,
size_t const  in_vertices1[],
size_t const  in_vertices2[],
bool const  in_visibilities[] 
)

Sets edge visibilities on a selection of arbitrary edges.

Parameters
in_countSize of the following arrays.
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_visibilitiesThe visibilities that should be set for each edge specified.
Returns
A reference to this MeshKey.

◆ SetEdgeVisibilitiesByList() [2/4]

MeshKey& HPS::MeshKey::SetEdgeVisibilitiesByList ( size_t  in_count,
size_t const  in_vertices1[],
size_t const  in_vertices2[],
bool  in_visibility 
)

Sets edge visibilities on a selection of arbitrary edges.

Parameters
in_countSize of the following arrays.
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_visibilityThe visibility to apply to each edge specified.
Returns
A reference to this MeshKey.

◆ SetEdgeVisibilitiesByList() [3/4]

MeshKey& HPS::MeshKey::SetEdgeVisibilitiesByList ( SizeTArray const &  in_vertices1,
SizeTArray const &  in_vertices2,
bool  in_visibility 
)

Sets edge visibilities on a selection of arbitrary edges.

Parameters
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_visibilityThe visibility to apply to each edge specified.
Returns
A reference to this MeshKey.

◆ SetEdgeVisibilitiesByList() [4/4]

MeshKey& HPS::MeshKey::SetEdgeVisibilitiesByList ( SizeTArray const &  in_vertices1,
SizeTArray const &  in_vertices2,
BoolArray const &  in_visibilities 
)

Sets edge visibilities on a selection of arbitrary edges.

Parameters
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_visibilitiesThe visibilities that should be set for each edge specified.
Returns
A reference to this MeshKey.

◆ SetFaceIndexColorsByList() [1/4]

MeshKey& HPS::MeshKey::SetFaceIndexColorsByList ( size_t  in_count,
size_t const  in_faces[],
float const  in_indices[] 
)

Sets face material indices on a selection of arbitrary faces.

Parameters
in_countSize of the following arrays.
in_facesThe indices of the faces on which to set the colors.
in_indicesThe material indices to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceIndexColorsByList() [2/4]

MeshKey& HPS::MeshKey::SetFaceIndexColorsByList ( SizeTArray const &  in_faces,
FloatArray const &  in_indices 
)

Sets face material indices on a selection of arbitrary faces. If the sizes of the face index and material index arrays are different, the smaller size will be used.

Parameters
in_facesThe indices of the faces on which to set the colors.
in_indicesThe material indices to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceIndexColorsByList() [3/4]

MeshKey& HPS::MeshKey::SetFaceIndexColorsByList ( size_t  in_count,
size_t const  in_faces[],
float  in_index 
)

Sets a single material index on a selection of arbitrary faces.

Parameters
in_countSize of the following array.
in_facesThe indices of the faces on which to set the color.
in_indexThe material index to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceIndexColorsByList() [4/4]

MeshKey& HPS::MeshKey::SetFaceIndexColorsByList ( SizeTArray const &  in_faces,
float  in_index 
)

Sets a single material index on a selection of arbitrary faces.

Parameters
in_facesThe indices of the faces on which to set the color.
in_indexThe material index to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceIndexColorsByRange() [1/3]

MeshKey& HPS::MeshKey::SetFaceIndexColorsByRange ( size_t  in_start,
size_t  in_count,
float const  in_indices[] 
)

Sets face material indices on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed.
in_countSize of the following array. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_indicesThe material indices to set on the faces for this MeshKey.
Returns
A reference to this MeshKey.

◆ SetFaceIndexColorsByRange() [2/3]

MeshKey& HPS::MeshKey::SetFaceIndexColorsByRange ( size_t  in_start,
FloatArray const &  in_indices 
)

Sets face material indices on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed.
in_indicesThe material indices to set on the faces for this MeshKey. The size of the array must be such that in_start+in_indices.size()<=face_count for the setting to succeed.
Returns
A reference to this MeshKey.

◆ SetFaceIndexColorsByRange() [3/3]

MeshKey& HPS::MeshKey::SetFaceIndexColorsByRange ( size_t  in_start,
size_t  in_count,
float  in_index 
)

Sets a single material index on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting the color. This value must be such that in_start<face_count for setting to succeed.
in_countThe number of faces on which to set the color. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_indexThe material index to set on the faces for this MeshKey.
Returns
A reference to this MeshKey.

◆ SetFaceNormalsByList() [1/4]

MeshKey& HPS::MeshKey::SetFaceNormalsByList ( size_t  in_count,
size_t const  in_faces[],
Vector const  in_normals[] 
)

Sets face normals on a selection of arbitrary faces.

Parameters
in_countSize of the following arrays.
in_facesThe indices of the faces on which to set the normals.
in_normalsThe normals to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceNormalsByList() [2/4]

MeshKey& HPS::MeshKey::SetFaceNormalsByList ( SizeTArray const &  in_faces,
VectorArray const &  in_normals 
)

Sets face normals on a selection of arbitrary faces. If the sizes of the face index and normal arrays are different, the smaller size will be used.

Parameters
in_facesThe indices of the faces on which to set the normals.
in_normalsThe normals to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceNormalsByList() [3/4]

MeshKey& HPS::MeshKey::SetFaceNormalsByList ( size_t  in_count,
size_t const  in_faces[],
Vector const &  in_normal 
)

Sets a single normal on a selection of arbitrary faces.

Parameters
in_countSize of the following array.
in_facesThe indices of the faces on which to set the normal.
in_normalThe normal to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceNormalsByList() [4/4]

MeshKey& HPS::MeshKey::SetFaceNormalsByList ( SizeTArray const &  in_faces,
Vector const &  in_normal 
)

Sets a single normal on a selection of arbitrary faces.

Parameters
in_facesThe indices of the faces on which to set the normal.
in_normalThe normal to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceNormalsByRange() [1/3]

MeshKey& HPS::MeshKey::SetFaceNormalsByRange ( size_t  in_start,
size_t  in_count,
Vector const  in_normals[] 
)

Sets face normals on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting normals. This value must be such that in_start<face_count for setting to succeed.
in_countSize of the following array. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_normalsThe normals to set on the faces for this MeshKey.
Returns
A reference to this MeshKey.

◆ SetFaceNormalsByRange() [2/3]

MeshKey& HPS::MeshKey::SetFaceNormalsByRange ( size_t  in_start,
VectorArray const &  in_normals 
)

Sets face normals on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting normals. This value must be such that in_start<face_count for setting to succeed.
in_normalsThe normals to set on the faces for this MeshKey. The size of the array must be such that in_start+in_normals.size()<=face_count for the setting to succeed.
Returns
A reference to this MeshKey.

◆ SetFaceNormalsByRange() [3/3]

MeshKey& HPS::MeshKey::SetFaceNormalsByRange ( size_t  in_start,
size_t  in_count,
Vector const &  in_normal 
)

Sets a single normal on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting the normal. This value must be such that in_start<face_count for setting to succeed.
in_countThe number of faces on which to set the normal. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_normalThe normal to set on the faces for this MeshKey.
Returns
A reference to this MeshKey.

◆ SetFaceRGBColorsByList() [1/4]

MeshKey& HPS::MeshKey::SetFaceRGBColorsByList ( size_t  in_count,
size_t const  in_faces[],
RGBColor const  in_rgb_colors[] 
)

Sets face RGB colors on a selection of arbitrary faces.

Parameters
in_countSize of the following arrays.
in_facesThe indices of the faces on which to set the colors.
in_rgb_colorsThe RGB colors to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceRGBColorsByList() [2/4]

MeshKey& HPS::MeshKey::SetFaceRGBColorsByList ( SizeTArray const &  in_faces,
RGBColorArray const &  in_rgb_colors 
)

Sets face RGB colors on a selection of arbitrary faces. If the sizes of the face index array and the color array different, the smaller size will be used.

Parameters
in_facesThe indices of the faces on which to set the colors.
in_rgb_colorsThe RGB colors to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceRGBColorsByList() [3/4]

MeshKey& HPS::MeshKey::SetFaceRGBColorsByList ( size_t  in_count,
size_t const  in_faces[],
RGBColor const &  in_rgb_color 
)

Sets a single RGB color on a selection of arbitrary faces.

Parameters
in_countSize of the following array.
in_facesThe indices of the faces on which to set the color.
in_rgb_colorThe RGB color to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceRGBColorsByList() [4/4]

MeshKey& HPS::MeshKey::SetFaceRGBColorsByList ( SizeTArray const &  in_faces,
RGBColor const &  in_rgb_color 
)

Sets a single RGB color on a selection of arbitrary faces.

Parameters
in_facesThe indices of the faces on which to set the color.
in_rgb_colorThe RGB color to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceRGBColorsByRange() [1/3]

MeshKey& HPS::MeshKey::SetFaceRGBColorsByRange ( size_t  in_start,
size_t  in_count,
RGBColor const  in_rgb_colors[] 
)

Sets face RGB colors on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed.
in_countSize of the following array. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_rgb_colorsThe RGB colors to set on the faces for this MeshKey.
Returns
A reference to this MeshKey.

◆ SetFaceRGBColorsByRange() [2/3]

MeshKey& HPS::MeshKey::SetFaceRGBColorsByRange ( size_t  in_start,
RGBColorArray const &  in_rgb_colors 
)

Sets face RGB colors on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed.
in_rgb_colorsThe RGB colors to set on the faces for this MeshKey. The size of the array must be such that in_start+in_rgb_colors.size()<=face_count for the setting to succeed.
Returns
A reference to this MeshKey.

◆ SetFaceRGBColorsByRange() [3/3]

MeshKey& HPS::MeshKey::SetFaceRGBColorsByRange ( size_t  in_start,
size_t  in_count,
RGBColor const &  in_rgb_color 
)

Sets a single RGB color on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting the color. This value must be such that in_start<face_count for setting to succeed.
in_countThe number of faces on which to set the color. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_rgb_colorThe RGB color to set on the faces for this MeshKey.
Returns
A reference to this MeshKey.

◆ SetFaceVisibilitiesByList() [1/4]

MeshKey& HPS::MeshKey::SetFaceVisibilitiesByList ( size_t  in_count,
size_t const  in_faces[],
bool const  in_visibilities[] 
)

Sets face visibilities on a selection of arbitrary faces.

Parameters
in_countSize of the following arrays.
in_facesThe indices of the faces on which to set the visibilities.
in_visibilitiesThe visibilities to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceVisibilitiesByList() [2/4]

MeshKey& HPS::MeshKey::SetFaceVisibilitiesByList ( SizeTArray const &  in_faces,
BoolArray const &  in_visibilities 
)

Sets face visibilities on a selection of arbitrary faces. If the sizes of the face index and visibility arrays are different, the smaller size will be used.

Parameters
in_facesThe indices of the faces on which to set the visibilities.
in_visibilitiesThe visibilities to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceVisibilitiesByList() [3/4]

MeshKey& HPS::MeshKey::SetFaceVisibilitiesByList ( size_t  in_count,
size_t const  in_faces[],
bool  in_visibility 
)

Sets a single visibility on a selection of arbitrary faces.

Parameters
in_countSize of the following array.
in_facesThe indices of the faces on which to set the visibility.
in_visibilityThe visibility to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceVisibilitiesByList() [4/4]

MeshKey& HPS::MeshKey::SetFaceVisibilitiesByList ( SizeTArray const &  in_faces,
bool  in_visibility 
)

Sets a single visibility on a selection of arbitrary faces.

Parameters
in_facesThe indices of the faces on which to set the visibility.
in_visibilityThe visibility to set on the faces.
Returns
A reference to this MeshKey.

◆ SetFaceVisibilitiesByRange() [1/3]

MeshKey& HPS::MeshKey::SetFaceVisibilitiesByRange ( size_t  in_start,
size_t  in_count,
bool const  in_visibilities[] 
)

Sets face visibilities on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting visibilities. This value must be such that in_start<face_count for setting to succeed.
in_countSize of the following array. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_visibilitiesThe visibilities to set on the faces for this MeshKey.
Returns
A reference to this MeshKey.

◆ SetFaceVisibilitiesByRange() [2/3]

MeshKey& HPS::MeshKey::SetFaceVisibilitiesByRange ( size_t  in_start,
BoolArray const &  in_visibilities 
)

Sets face visibilities on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting visibilities. This value must be such that in_start<face_count for setting to succeed.
in_visibilitiesThe visibilities to set on the faces for this MeshKey. The size of the array must be such that in_start+in_visibilities.size()<=face_count for the setting to succeed.
Returns
A reference to this MeshKey.

◆ SetFaceVisibilitiesByRange() [3/3]

MeshKey& HPS::MeshKey::SetFaceVisibilitiesByRange ( size_t  in_start,
size_t  in_count,
bool  in_visibility 
)

Sets a single visibility on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting the visibility. This value must be such that in_start<face_count for setting to succeed.
in_countThe number of faces on which to set the visibility. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_visibilityThe visibility to set on the faces for this MeshKey.
Returns
A reference to this MeshKey.

◆ SetMaterialMapping()

MeshKey& HPS::MeshKey::SetMaterialMapping ( MaterialMappingKit const &  in_kit)

Sets the specified material mappings on this MeshKey. Only face, back face, cut edge, cut face, edge, and vertex materials will be set on the mesh. These material settings will be "global" for the mesh, i.e., all types will get the material for that type. To get different materials for the same types, e.g., faces with different colors, it is necessary to use the per-vertex or per-face functions.

Parameters
in_kitThe material mappings to set on this MeshKey.
Returns
A reference to this MeshKey.

◆ SetPoints() [1/2]

MeshKey& HPS::MeshKey::SetPoints ( size_t  in_rows,
size_t  in_columns,
PointArray const &  in_points 
)

Replace the points on this MeshKey with the specified points.

Parameters
in_rowsThe number of rows for this MeshKey.
in_columnsThe number of columns for this MeshKey.
in_pointsThe points to use to replace those on this MeshKey.
Returns
A reference to this MeshKey.

◆ SetPoints() [2/2]

MeshKey& HPS::MeshKey::SetPoints ( size_t  in_rows,
size_t  in_columns,
size_t  in_count,
Point const  in_points[] 
)

Replace the points on this MeshKey with the specified points.

Parameters
in_rowsThe number of rows for this MeshKey.
in_columnsThe number of columns for this MeshKey.
in_countSize of the following array.
in_pointsThe points to use to replace those on this MeshKey.
Returns
A reference to this MeshKey.

◆ SetVertexIndexColorsByList() [1/4]

MeshKey& HPS::MeshKey::SetVertexIndexColorsByList ( size_t  in_count,
size_t const  in_vertices[],
float const  in_indices[],
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters
in_countSize of the following arrays.
in_verticesThe indices of the vertices on which to set the colors.
in_indicesThe material indices to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexIndexColorsByList() [2/4]

MeshKey& HPS::MeshKey::SetVertexIndexColorsByList ( SizeTArray const &  in_vertices,
FloatArray const &  in_indices,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified mesh component. If the sizes of the vertex index and material index arrays are different, the smaller size will be used.

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_indicesThe material indices to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexIndexColorsByList() [3/4]

MeshKey& HPS::MeshKey::SetVertexIndexColorsByList ( size_t  in_count,
size_t const  in_vertices[],
float  in_index,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets a single material index on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters
in_countSize of the following array.
in_verticesThe indices of the vertices on which to set the color.
in_indexThe material index to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexIndexColorsByList() [4/4]

MeshKey& HPS::MeshKey::SetVertexIndexColorsByList ( SizeTArray const &  in_vertices,
float  in_index,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets a single material index on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters
in_verticesThe indices of the vertices on which to set the color.
in_indexThe material index to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexIndexColorsByRange() [1/3]

MeshKey& HPS::MeshKey::SetVertexIndexColorsByRange ( size_t  in_start,
size_t  in_count,
float const  in_indices[],
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_countSize of the following array. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.
in_indicesThe material indices to set on the vertices for this MeshKey.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexIndexColorsByRange() [2/3]

MeshKey& HPS::MeshKey::SetVertexIndexColorsByRange ( size_t  in_start,
FloatArray const &  in_indices,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_indicesThe material indices to set on the vertices for this MeshKey. The size of the array must be such that in_start+in_indices.size()<=vertex_count for the setting to succeed.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexIndexColorsByRange() [3/3]

MeshKey& HPS::MeshKey::SetVertexIndexColorsByRange ( size_t  in_start,
size_t  in_count,
float  in_index,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets a single material index on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the color. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.
in_indexThe material index to set on the vertices for this MeshKey.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexNormalsByList() [1/4]

MeshKey& HPS::MeshKey::SetVertexNormalsByList ( size_t  in_count,
size_t const  in_vertices[],
Vector const  in_normals[] 
)

Sets vertex normals on a selection of arbitrary vertices.

Parameters
in_countSize of the following arrays.
in_verticesThe indices of the vertices on which to set the normals.
in_normalsThe normals to set on the vertices.
Returns
A reference to this MeshKey.

◆ SetVertexNormalsByList() [2/4]

MeshKey& HPS::MeshKey::SetVertexNormalsByList ( SizeTArray const &  in_vertices,
VectorArray const &  in_normals 
)

Sets vertex normals on a selection of arbitrary vertices. If the sizes of the vertex index and normal arrays are different, the smaller size will be used.

Parameters
in_verticesThe indices of the vertices on which to set the normals.
in_normalsThe normals to set on the vertices.
Returns
A reference to this MeshKey.

◆ SetVertexNormalsByList() [3/4]

MeshKey& HPS::MeshKey::SetVertexNormalsByList ( size_t  in_count,
size_t const  in_vertices[],
Vector const &  in_normal 
)

Sets a single normal on a selection of arbitrary vertices.

Parameters
in_countSize of the following array.
in_verticesThe indices of the vertices on which to set the normal.
in_normalThe normal to set on the vertices.
Returns
A reference to this MeshKey.

◆ SetVertexNormalsByList() [4/4]

MeshKey& HPS::MeshKey::SetVertexNormalsByList ( SizeTArray const &  in_vertices,
Vector const &  in_normal 
)

Sets a single normal on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to set the normal.
in_normalThe normal to set on the vertices.
Returns
A reference to this MeshKey.

◆ SetVertexNormalsByRange() [1/3]

MeshKey& HPS::MeshKey::SetVertexNormalsByRange ( size_t  in_start,
size_t  in_count,
Vector const  in_normals[] 
)

Sets vertex normals on a range of vertices starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting normals. This value must be such that in_start<point_count for setting to succeed.
in_countSize of the following array. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.
in_normalsThe normals to set on the vertices for this MeshKey.
Returns
A reference to this MeshKey.

◆ SetVertexNormalsByRange() [2/3]

MeshKey& HPS::MeshKey::SetVertexNormalsByRange ( size_t  in_start,
VectorArray const &  in_normals 
)

Sets vertex normals on a range of vertices starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting normals. This value must be such that in_start<point_count for setting to succeed.
in_normalsThe normals to set on the vertices for this MeshKey. The size of the array must be such that in_start+in_normals.size()<=vertex_count for the setting to succeed.
Returns
A reference to this MeshKey.

◆ SetVertexNormalsByRange() [3/3]

MeshKey& HPS::MeshKey::SetVertexNormalsByRange ( size_t  in_start,
size_t  in_count,
Vector const &  in_normal 
)

Sets a single normal on a range of vertices starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting the normal. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the normal. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.
in_normalThe normal to set on the vertices for this MeshKey.
Returns
A reference to this MeshKey.

◆ SetVertexParametersByList() [1/2]

MeshKey& HPS::MeshKey::SetVertexParametersByList ( size_t  in_vertex_count,
size_t const  in_vertices[],
size_t  in_param_count,
float const  in_params[],
size_t  in_param_width = 2 
)

Sets texture parameters on a selection of arbitrary vertices. If the sizes of the vertex index array and the texture paramter array (divided by the parameter width) are different, the smaller size will be used.

Parameters
in_vertex_countSize of the following array.
in_verticesThe indices of the vertices on which to set the texture parameters.
in_param_countSize of the following array. This should be divisible by the parameter width, if it is not, some parameters will get ignored.
in_paramsThe texture parameters to set on the vertices for this MeshKey.
in_param_widthThe number of texture parameters per vertex. Defaults to 2.
Returns
A reference to this MeshKey.

◆ SetVertexParametersByList() [2/2]

MeshKey& HPS::MeshKey::SetVertexParametersByList ( SizeTArray const &  in_vertices,
FloatArray const &  in_params,
size_t  in_param_width = 2 
)

Sets texture parameters on a selection of arbitrary vertices. If the sizes of the vertex index array and the texture paramter array (divided by the parameter width) are different, the smaller size will be used.

Parameters
in_verticesThe indices of the vertices on which to set the texture parameters.
in_paramsThe texture parameters to set on the vertices for this MeshKey. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored.
in_param_widthThe number of texture parameters per vertex. Defaults to 2.
Returns
A reference to this MeshKey.

◆ SetVertexParametersByRange() [1/2]

MeshKey& HPS::MeshKey::SetVertexParametersByRange ( size_t  in_start,
size_t  in_param_count,
float const  in_params[],
size_t  in_param_width = 2 
)

Sets texture parameters on a range of vertices starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting texture parameters. This value must be such that in_start<point_count for setting to succeed.
in_param_countSize of the following array. This should be divisible by the parameter width, if it is not, some parameters will get ignored. This value must be such that in_start+in_param_count/in_param_width<=point_count for the setting to succeed.
in_paramsThe texture parameters to set on the vertices for this MeshKey.
in_param_widthThe number of texture parameters per vertex. Defaults to 2.
Returns
A reference to this MeshKey.

◆ SetVertexParametersByRange() [2/2]

MeshKey& HPS::MeshKey::SetVertexParametersByRange ( size_t  in_start,
FloatArray const &  in_params,
size_t  in_param_width = 2 
)

Sets texture parameters on a range of vertices starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting texture parameters. This value must be such that in_start<point_count for setting to succeed.
in_paramsThe texture parameters to set on the vertices for this MeshKey. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored. This value must be such that in_start+in_params.size()/in_param_width<=point_count for the setting to succeed.
in_param_widthThe number of texture parameters per vertex. Defaults to 2.
Returns
A reference to this MeshKey.

◆ SetVertexRGBAColorsByList() [1/4]

MeshKey& HPS::MeshKey::SetVertexRGBAColorsByList ( size_t  in_count,
size_t const  in_vertices[],
RGBAColor const  in_rgba_colors[],
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets vertex RGBA colors on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters
in_countSize of the following arrays.
in_verticesThe indices of the vertices on which to set the colors.
in_rgba_colorsThe RGBA colors to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexRGBAColorsByList() [2/4]

MeshKey& HPS::MeshKey::SetVertexRGBAColorsByList ( SizeTArray const &  in_vertices,
RGBAColorArray const &  in_rgba_colors,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets vertex RGBA colors on a selection of arbitrary vertices which apply to the specified mesh component. If the sizes of the vertex index array and color array are different, the smaller size will be used.

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_rgba_colorsThe RGBA colors to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexRGBAColorsByList() [3/4]

MeshKey& HPS::MeshKey::SetVertexRGBAColorsByList ( size_t  in_count,
size_t const  in_vertices[],
RGBAColor const &  in_rgba_color,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets a single RGBA color on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters
in_countSize of the following array.
in_verticesThe indices of the vertices on which to set the color.
in_rgba_colorThe RGBA color to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexRGBAColorsByList() [4/4]

MeshKey& HPS::MeshKey::SetVertexRGBAColorsByList ( SizeTArray const &  in_vertices,
RGBAColor const &  in_rgba_color,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets a single RGBA color on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters
in_verticesThe indices of the vertices on which to set the color.
in_rgba_colorThe RGBA color to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexRGBAColorsByRange() [1/3]

MeshKey& HPS::MeshKey::SetVertexRGBAColorsByRange ( size_t  in_start,
size_t  in_count,
RGBAColor const  in_rgba_colors[],
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets vertex RGBA colors on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_countSize of the following array. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.
in_rgba_colorsThe RGBA colors to set on the vertices for this MeshKey.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexRGBAColorsByRange() [2/3]

MeshKey& HPS::MeshKey::SetVertexRGBAColorsByRange ( size_t  in_start,
RGBAColorArray const &  in_rgba_colors,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets vertex RGBA colors on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_rgba_colorsThe RGBA colors to set on the vertices for this MeshKey. The size of the array must be such that in_start+in_rgba_colors.size()<=vertex_count for the setting to succeed.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexRGBAColorsByRange() [3/3]

MeshKey& HPS::MeshKey::SetVertexRGBAColorsByRange ( size_t  in_start,
size_t  in_count,
RGBAColor const &  in_rgba_color,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets a single RGBA color on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the color. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.
in_rgba_colorThe RGBA color to set on the vertices for this MeshKey.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexRGBColorsByList() [1/4]

MeshKey& HPS::MeshKey::SetVertexRGBColorsByList ( size_t  in_count,
size_t const  in_vertices[],
RGBColor const  in_rgb_colors[],
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters
in_countSize of the following arrays.
in_verticesThe indices of the vertices on which to set the colors.
in_rgb_colorsThe RGB colors to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexRGBColorsByList() [2/4]

MeshKey& HPS::MeshKey::SetVertexRGBColorsByList ( SizeTArray const &  in_vertices,
RGBColorArray const &  in_rgb_colors,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified mesh component. If the sizes of the vertex index array and the color array different, the smaller size will be used.

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_rgb_colorsThe RGB colors to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexRGBColorsByList() [3/4]

MeshKey& HPS::MeshKey::SetVertexRGBColorsByList ( size_t  in_count,
size_t const  in_vertices[],
RGBColor const &  in_rgb_color,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets a single RGB color on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters
in_countSize of the following array.
in_verticesThe indices of the vertices on which to set the color.
in_rgb_colorThe RGB color to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexRGBColorsByList() [4/4]

MeshKey& HPS::MeshKey::SetVertexRGBColorsByList ( SizeTArray const &  in_vertices,
RGBColor const &  in_rgb_color,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets a single RGB color on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters
in_verticesThe indices of the vertices on which to set the color.
in_rgb_colorThe RGB color to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexRGBColorsByRange() [1/3]

MeshKey& HPS::MeshKey::SetVertexRGBColorsByRange ( size_t  in_start,
size_t  in_count,
RGBColor const  in_rgb_colors[],
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_countSize of the following array. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.
in_rgb_colorsThe RGB colors to set on the vertices for this MeshKey.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexRGBColorsByRange() [2/3]

MeshKey& HPS::MeshKey::SetVertexRGBColorsByRange ( size_t  in_start,
RGBColorArray const &  in_rgb_colors,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_rgb_colorsThe RGB colors to set on the vertices for this MeshKey. The size of the array must be such that in_start+in_rgb_colors.size()<=vertex_count for the setting to succeed.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexRGBColorsByRange() [3/3]

MeshKey& HPS::MeshKey::SetVertexRGBColorsByRange ( size_t  in_start,
size_t  in_count,
RGBColor const &  in_rgb_color,
Mesh::Component  in_apply_to = Mesh::Component::Faces 
)

Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the color. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.
in_rgb_colorThe RGB color to set on the vertices for this MeshKey.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.

◆ SetVertexVisibilitiesByList() [1/4]

MeshKey& HPS::MeshKey::SetVertexVisibilitiesByList ( size_t  in_count,
size_t const  in_vertices[],
bool const  in_visibilities[] 
)

Sets vertex visibilities on a selection of arbitrary vertices.

Parameters
in_countSize of the following arrays.
in_verticesThe indices of the vertices on which to set the visibilities.
in_visibilitiesThe visibilities to set on the vertices.
Returns
A reference to this MeshKey.

◆ SetVertexVisibilitiesByList() [2/4]

MeshKey& HPS::MeshKey::SetVertexVisibilitiesByList ( SizeTArray const &  in_vertices,
BoolArray const &  in_visibilities 
)

Sets vertex visibilities on a selection of arbitrary vertices. If the sizes of the vertex index and visibility arrays are different, the smaller size will be used.

Parameters
in_verticesThe indices of the vertices on which to set the visibilities.
in_visibilitiesThe visibilities to set on the vertices.
Returns
A reference to this MeshKey.

◆ SetVertexVisibilitiesByList() [3/4]

MeshKey& HPS::MeshKey::SetVertexVisibilitiesByList ( size_t  in_count,
size_t const  in_vertices[],
bool  in_visibility 
)

Sets a single visibility on a selection of arbitrary vertices.

Parameters
in_countSize of the following array.
in_verticesThe indices of the vertices on which to set the visibility.
in_visibilityThe visibility to set on the vertices.
Returns
A reference to this MeshKey.

◆ SetVertexVisibilitiesByList() [4/4]

MeshKey& HPS::MeshKey::SetVertexVisibilitiesByList ( SizeTArray const &  in_vertices,
bool  in_visibility 
)

Sets a single visibility on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to set the visibility.
in_visibilityThe visibility to set on the vertices.
Returns
A reference to this MeshKey.

◆ SetVertexVisibilitiesByRange() [1/3]

MeshKey& HPS::MeshKey::SetVertexVisibilitiesByRange ( size_t  in_start,
size_t  in_count,
bool const  in_visibilities[] 
)

Sets vertex visibilities on a range of vertices starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting visibilities. This value must be such that in_start<point_count for setting to succeed.
in_countSize of the following array. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.
in_visibilitiesThe visibilities to set on the vertices for this MeshKey.
Returns
A reference to this MeshKey.

◆ SetVertexVisibilitiesByRange() [2/3]

MeshKey& HPS::MeshKey::SetVertexVisibilitiesByRange ( size_t  in_start,
BoolArray const &  in_visibilities 
)

Sets vertex visibilities on a range of vertices starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting visibilities. This value must be such that in_start<point_count for setting to succeed.
in_visibilitiesThe visibilities to set on the vertices for this MeshKey. The size of the array must be such that in_start+in_visibilities.size()<=vertex_count for the setting to succeed.
Returns
A reference to this MeshKey.

◆ SetVertexVisibilitiesByRange() [3/3]

MeshKey& HPS::MeshKey::SetVertexVisibilitiesByRange ( size_t  in_start,
size_t  in_count,
bool  in_visibility 
)

Sets a single visibility on a range of vertices starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting the visibility. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the visibility. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.
in_visibilityThe visibility to set on the vertices for this MeshKey.
Returns
A reference to this MeshKey.

◆ Show()

void HPS::MeshKey::Show ( MeshKit out_kit) const

Copy the contents of this MeshKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this MeshKey.

◆ ShowColumns()

bool HPS::MeshKey::ShowColumns ( size_t &  out_columns) const

Show the number of columns for this MeshKey.

Parameters
out_columnsThe number of columns for this MeshKey.
Returns
true if columns were set, false otherwise.

◆ ShowEdgeColors()

bool HPS::MeshKey::ShowEdgeColors ( SizeTArray out_vertices1,
SizeTArray out_vertices2,
HPS::MaterialTypeArray out_types,
HPS::RGBColorArray out_rgb_colors,
HPS::FloatArray out_indices 
)

Sets edge colors on a selection of arbitrary edges.

Parameters
out_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed.
out_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed.
out_typesThe types of edge colors for each edge.
out_rgb_colorsThe colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is RGBColor.
out_indicesThe colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is MaterialIndex.
Returns
A reference to this MeshKey.

◆ ShowEdgeColorsByList()

bool HPS::MeshKey::ShowEdgeColorsByList ( SizeTArray const &  in_vertices1,
SizeTArray const &  in_vertices2,
HPS::MaterialTypeArray out_types,
HPS::RGBColorArray out_rgb_colors,
HPS::FloatArray out_indices 
)

Sets edge colors on a selection of arbitrary edges.

Parameters
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
out_typesThe types of edge colors for each edge.
out_rgb_colorsThe colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is Material::Type::RGBColor.
out_indicesThe colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is Material::Type::MaterialIndex.
Returns
A reference to this MeshKey.

◆ ShowEdgeVisibilitiesByList()

bool HPS::MeshKey::ShowEdgeVisibilitiesByList ( SizeTArray const &  in_vertices1,
SizeTArray const &  in_vertices2,
BoolArray out_validities,
BoolArray out_visibilities 
) const

Shows all the edge visibilities on this ShellKey.

Parameters
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being shown. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being shown. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
out_validitiesThe validities of the visibilities for each edge. If an edge has a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe edge visibilities for each edge. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any vertex had a vertex visibility set, false otherwise.

◆ ShowFaceColors()

bool HPS::MeshKey::ShowFaceColors ( MaterialTypeArray out_types,
RGBColorArray out_rgb_colors,
FloatArray out_indices 
) const

Shows the face colors on MeshKey.

Parameters
out_typesThe types of face colors for each face. If a face does not have a face color set, the entry in this array will be Material::Type::None.
out_rgb_colorsThe RGB colors for each face. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_indicesThe material indices for each face. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.
Returns
true if any face had a face color set, false otherwise.

◆ ShowFaceColorsByList()

bool HPS::MeshKey::ShowFaceColorsByList ( SizeTArray const &  in_faces,
MaterialTypeArray out_types,
RGBColorArray out_rgb_colors,
FloatArray out_indices 
) const

Shows the face colors on a selection of arbitrary faces. The order of the values in the ouput arrays is the same as the input face index array, i.e., the values of out_types[i], out_rgb_colors[i], and out_indices[i], correspond to the face at index in_faces[i].

Parameters
in_facesThe indices of the faces on which to show the colors.
out_typesThe types of face colors for each face at the specified index. If a face at a specified index does not have a face color set, the entry in this array will be Material::Type::None.
out_rgb_colorsThe RGB colors for each face at the specified index. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_indicesThe material indices for each face at the specified index. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.
Returns
true if any specified face had a face color set, false otherwise.

◆ ShowFaceColorsByRange()

bool HPS::MeshKey::ShowFaceColorsByRange ( size_t  in_start,
size_t  in_count,
MaterialTypeArray out_types,
RGBColorArray out_rgb_colors,
FloatArray out_indices 
) const

Shows the face colors on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start showing colors. This value must be such that in_start<face_count for showing to succeed.
in_countThe number of colors to show.
out_typesThe types of face colors for each face in the specified range. If a face in the specified range does not have a face color set, the entry in this array will be Material::Type::None.
out_rgb_colorsThe RGB colors for each face in the specified range. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_indicesThe material indices for each face in the specified range. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.
Returns
true if any face in the specified range had a face color set, false otherwise.

◆ ShowFaceNormals()

bool HPS::MeshKey::ShowFaceNormals ( BoolArray out_validities,
VectorArray out_normals 
) const

Shows all the face normals for this MeshKey.

Parameters
out_validitiesThe validities of the normals for each face. If a face had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normalsThe face normals for each face. out_normals[i] is only valid if out_validities[i] is true.
Returns
true if any face had a face normal set, false otherwise.

◆ ShowFaceNormalsByList()

bool HPS::MeshKey::ShowFaceNormalsByList ( SizeTArray const &  in_faces,
BoolArray out_validities,
VectorArray out_normals 
) const

Shows the face normals on a selection of arbitrary faces. The order of the values in the output arrays is the same as the input face index array, i.e., the values of out_validities[i] and out_normals[i] correspond to the face at index in_faces[i].

Parameters
in_facesThe indices of the faces on which to show the normals.
out_validitiesThe validities of the normals for each face at the specified index. If a face at a specified index had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normalsThe face normals for each face at the specified index. out_normals[i] is only valid if out_validities[i] is true.
Returns
true if any specified face had a face normal set, false otherwise.

◆ ShowFaceNormalsByRange()

bool HPS::MeshKey::ShowFaceNormalsByRange ( size_t  in_start,
size_t  in_count,
BoolArray out_validities,
VectorArray out_normals 
) const

Shows the face normals on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start showing normals. This value must be such that in_start<face_count for showing to succeed.
in_countThe number of normals to show.
out_validitiesThe validities of the normals for each face in the specified range. If a face in the specified range had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normalsThe face normals for each face in the specified range. out_normals[i] is only valid if out_validities[i] is true.
Returns
true if any face in the specified range had a face normal set, false otherwise.

◆ ShowFaceVisibilities()

bool HPS::MeshKey::ShowFaceVisibilities ( BoolArray out_validities,
BoolArray out_visibilities 
) const

Shows all the face visibilities on this MeshKey.

Parameters
out_validitiesThe validities of the visibilities for each face. If a face had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe face visibilities or each face. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any face had a face visibility set, false otherwise.

◆ ShowFaceVisibilitiesByList()

bool HPS::MeshKey::ShowFaceVisibilitiesByList ( SizeTArray const &  in_faces,
BoolArray out_validities,
BoolArray out_visibilities 
) const

Shows the face visibilities on a selection of arbitrary faces. The order of the values in the output arrays is the same as the input face index array, i.e., the values of out_validities[i] and out_visibilities[i] correspond to the face at index in_faces[i].

Parameters
in_facesThe indices of the faces on which to show the normals.
out_validitiesThe validities of the normals for each face at the specified index. If a face at a specified index had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe face visibilities for each face at the specified index. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any specified face had a face visibility set, false otherwise.

◆ ShowFaceVisibilitiesByRange()

bool HPS::MeshKey::ShowFaceVisibilitiesByRange ( size_t  in_start,
size_t  in_count,
BoolArray out_validities,
BoolArray out_visibilities 
) const

Shows the face visibilities on a range of faces starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start showing visibilities. This value must be such that in_start<face_count for showing to succeed.
in_countThe number of visibilities to show.
out_validitiesThe validities of the visibilities for each face in the specified range. If a face in the specified range had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe face visibilities for each face in the specified range. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any face in the specified range had a face visibility set, false otherwise.

◆ ShowMaterialMapping()

bool HPS::MeshKey::ShowMaterialMapping ( MaterialMappingKit out_kit) const

Shows the material mappings set on this MeshKey. These are the "global" material settings, not the per-vertex and per-face material settings.

Parameters
out_kitThe material mappings set on this MeshKey.
Returns
true if material mappings were set, false otherwise.

◆ ShowNetVertexNormals()

bool HPS::MeshKey::ShowNetVertexNormals ( VectorArray out_normals,
Drawing::Handedness  in_polygon_handedness = Drawing::Handedness::None 
) const

Shows the all net vertex normals on this MeshKey.

Parameters
out_normalsThe vertex normals for each vertex.
in_polygon_handednessThe polygon handedness to assume when returning normals. Defaults to None. Specifying no handedness when requesting net normals, will return the normals using the handedness used internally by Visualize for this particular shell. When specifying a handedness, only normals which were implicitly calculated by Visualize will be flipped to conform to the requested handedness. User specified normals will be left untouched.
Returns
true if no errors were encountered, false otherwise.

◆ ShowNetVertexNormalsByRange()

bool HPS::MeshKey::ShowNetVertexNormalsByRange ( size_t  in_start,
size_t  in_count,
VectorArray out_normals,
Drawing::Handedness  in_polygon_handedness = Drawing::Handedness::None 
) const

Shows the net vertex normals on a range of vertices starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start showing normals. This value must be such that in_start<point_count for showing to succeed.
in_countThe number of normals to show. This value must be such that in_start+in_count<=point_count for the showing to succeed.
out_normalsThe vertex normals for each vertex in the specified range.
in_polygon_handednessThe polygon handedness to assume when returning normals. Defaults to None. Specifying no handedness when requesting net normals, will return the normals using the handedness used internally by Visualize for this particular shell. When specifying a handedness, only normals which were implicitly calculated by Visualize will be flipped to conform to the requested handedness. User specified normals will be left untouched.
Returns
true if no errors were encountered, false otherwise.

◆ ShowPoints() [1/2]

bool HPS::MeshKey::ShowPoints ( PointArray out_points) const

Show the points for this MeshKey.

Parameters
out_pointsThe points for this MeshKey.
Returns
true if points were set, false otherwise.

◆ ShowPoints() [2/2]

bool HPS::MeshKey::ShowPoints ( size_t &  out_rows,
size_t &  out_columns,
PointArray out_points 
) const

Show the number of rows, number of columns, and points for this MeshKey.

Parameters
out_rowsThe number of rows for this MeshKey.
out_columnsThe number of columns for this MeshKey.
out_pointsThe points for this MeshKey.
Returns
true if points were set, false otherwise.

◆ ShowPointsByList() [1/2]

bool HPS::MeshKey::ShowPointsByList ( SizeTArray const &  in_indices,
PointArray out_points 
) const

Show a subset of the points for this MeshKey by list.

Parameters
in_indicesThe list of point indices to show.
out_pointsThe requested points for this MeshKey.
Returns
true if all requested points were set, false otherwise.

◆ ShowPointsByList() [2/2]

bool HPS::MeshKey::ShowPointsByList ( size_t  in_count,
size_t const  in_indices[],
PointArray out_points 
) const

Show a subset of the points for this MeshKey by list.

Parameters
in_countThe number of points to show.
in_indicesThe list of point indices to show.
out_pointsThe requested points for this MeshKey.
Returns
true if all requested points were set, false otherwise.

◆ ShowPointsByRange()

bool HPS::MeshKey::ShowPointsByRange ( size_t  in_start_index,
size_t  in_count,
PointArray out_points 
) const

Show a subset of the points for this MeshKey by range.

Parameters
in_start_indexThe first point to show.
in_countThe number of points to show.
out_pointsThe requested points for this MeshKey.
Returns
true if all requested points were set, false otherwise.

◆ ShowRows()

bool HPS::MeshKey::ShowRows ( size_t &  out_rows) const

Show the number of rows for this MeshKey.

Parameters
out_rowsThe number of rows for this MeshKey.
Returns
true if rows were set, false otherwise.

◆ ShowVertexColors()

bool HPS::MeshKey::ShowVertexColors ( Mesh::Component  in_apply_to,
MaterialTypeArray out_types,
RGBColorArray out_rgb_colors,
RGBAColorArray out_rgba_colors,
FloatArray out_indices 
) const

Shows all the vertex colors on the specified mesh component.

Parameters
in_apply_toThe mesh component the colors should apply to.
out_typesThe types of vertex colors for each vertex. If a vertex does not have a vertex color set for the specified mesh component, the entry in this array will be Material::Type::None.
out_rgb_colorsThe RGB colors for each vertex. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_rgba_colorsThe RGBA colors for each vertex. out_rgba_colors[i] is only valid if out_types[i] is Material::Type::RGBAColor.
out_indicesThe material indices for each vertex. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.
Returns
true if any vertex colors were shown, false otherwise.

◆ ShowVertexColorsByList()

bool HPS::MeshKey::ShowVertexColorsByList ( SizeTArray const &  in_vertices,
Mesh::Component  in_apply_to,
MaterialTypeArray out_types,
RGBColorArray out_rgb_colors,
RGBAColorArray out_rgba_colors,
FloatArray out_indices 
) const

Shows the vertex colors on a selection of arbitrary vertices which apply to the specified mesh component. The order of the values in the ouput arrays is the same as the input vertex index array, i.e., the values of out_types[i], out_rgb_colors[i], out_rgba_colors[i], and out_indices[i], correspond to the vertex at index in_vertices[i].

Parameters
in_verticesThe indices of the vertices on which to show the colors.
in_apply_toThe mesh component the colors should apply to.
out_typesThe types of vertex colors for each vertex at the specified index. If a vertex at a specified index does not have a vertex color set for the specified component, the entry in this array will be Material::Type::None.
out_rgb_colorsThe RGB colors for each vertex at the specified index. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_rgba_colorsThe RGBA colors for each vertex at the specified index. out_rgba_colors[i] is only valid if out_types[i] is Material::Type::RGBAColor.
out_indicesThe material indices for each vertex at the specified index. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.
Returns
true if any specified vertex had a vertex color on the specified component set, false otherwise.

◆ ShowVertexColorsByRange()

bool HPS::MeshKey::ShowVertexColorsByRange ( size_t  in_start,
size_t  in_count,
Mesh::Component  in_apply_to,
MaterialTypeArray out_types,
RGBColorArray out_rgb_colors,
RGBAColorArray out_rgba_colors,
FloatArray out_indices 
) const

Shows the vertex colors on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start showing colors. This value must be such that in_start<point_count for removal to succeed.
in_countThe number of colors to show.
in_apply_toThe mesh component the colors should apply to.
out_typesThe types of vertex colors for each vertex in the specified range. If a vertex in the specified range does not have a vertex color set for the specified mesh component, the entry in this array will be Material::Type::None.
out_rgb_colorsThe RGB colors for each vertex in the specified range. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_rgba_colorsThe RGBA colors for each vertex in the specified range. out_rgba_colors[i] is only valid if out_types[i] is Material::Type::RGBAColor.
out_indicesThe material indices for each vertex in the specified range. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.
Returns
true if any vertex in the specified range had a vertex color on the specified component set, false otherwise.

◆ ShowVertexNormals()

bool HPS::MeshKey::ShowVertexNormals ( BoolArray out_validities,
VectorArray out_normals 
) const

Shows all the vertex normals on this MeshKey.

Parameters
out_validitiesThe validities of the normals for each vertex. If a vertex had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normalsThe vertex normals for each vertex. out_normals[i] is only valid if out_validities[i] is true.
Returns
true if any vertex normals were shown, false otherwise.

◆ ShowVertexNormalsByList()

bool HPS::MeshKey::ShowVertexNormalsByList ( SizeTArray const &  in_vertices,
BoolArray out_validities,
VectorArray out_normals 
) const

Shows the vertex normals on a selection of arbitrary vertices. The order of the values in the output arrays is the same as the input vertex index array, i.e., the values of out_validities[i] and out_normals[i] correspond to the vertex at index in_vertices[i].

Parameters
in_verticesThe indices of the vertices on which to show the normals.
out_validitiesThe validities of the normals for each vertex at the specified index. If a vertex at a specified index had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normalsThe vertex normals for each vertex at the specified index. out_normals[i] is only valid if out_validities[i] is true.
Returns
true if any specified vertex had a vertex normal set, false otherwise.

◆ ShowVertexNormalsByRange()

bool HPS::MeshKey::ShowVertexNormalsByRange ( size_t  in_start,
size_t  in_count,
BoolArray out_validities,
VectorArray out_normals 
) const

Shows the vertex normals on a range of vertices starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start showing normals. This value must be such that in_start<point_count for showing to succeed.
in_countThe number of normals to show.
out_validitiesThe validities of the normals for each vertex in the specified range. If a vertex in the specified range had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normalsThe vertex normals for each vertex in the specified range. out_normals[i] is only valid if out_validities[i] is true.
Returns
true if any vertex in the specified range had a vertex normal set, false otherwise.

◆ ShowVertexParameters() [1/2]

bool HPS::MeshKey::ShowVertexParameters ( BoolArray out_validities,
FloatArray out_params 
) const

Shows the texture parameters for all the vertices in this MeshKey. For this particular show function, the parameter width is returned implicitly and could be determined by out_params.size()/in_count.

Parameters
out_validitiesThe validities of the texture parameters for each vertex. If a vertex had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_paramsThe texture parameters for each vertex. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
Returns
true if any vertex had a texture parameter set, false otherwise.

◆ ShowVertexParameters() [2/2]

bool HPS::MeshKey::ShowVertexParameters ( BoolArray out_validities,
FloatArray out_params,
size_t &  out_param_width 
) const

Shows the texture parameters for all the vertices in this MeshKey.

Parameters
out_validitiesThe validities of the texture parameters for each vertex. If a vertex had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_paramsThe texture parameters for each vertex. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
out_param_widthThe number of texture parameters per vertex.
Returns
true if any vertex had a texture parameter set, false otherwise.

◆ ShowVertexParametersByList() [1/2]

bool HPS::MeshKey::ShowVertexParametersByList ( SizeTArray const &  in_vertices,
BoolArray out_validities,
FloatArray out_params 
) const

Shows the texture parameters on a selection of arbitrary vertices. For this particular show function, the parameter width is returned implicitly and could be determined by out_params.size()/in_vertices.size(). The order of the output arrays is the same as the input vertex index array, i.e., out_validities[i] and (out_params[i],...,out_params[i+param_width-1]) correspond to the vertex at index in_vertices[i].

Parameters
in_verticesThe indices of the vertices on which to show the texture parameters.
out_validitiesThe validities of the texture parameters for each vertex at the specified index. If a vertex at a specified index had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_paramsThe texture parameters for each vertex at the specified index. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
Returns
true if any specified vertex had a texture parameter set, false otherwise.

◆ ShowVertexParametersByList() [2/2]

bool HPS::MeshKey::ShowVertexParametersByList ( SizeTArray const &  in_vertices,
BoolArray out_validities,
FloatArray out_params,
size_t &  out_param_width 
) const

Shows the texture parameters on a selection of arbitrary vertices. The order of the output arrays is the same as the input vertex index array, i.e., out_validities[i] and (out_params[i],...,out_params[i+param_width-1]) correspond to the vertex at index in_vertices[i].

Parameters
in_verticesThe indices of the vertices on which to show the texture parameters.
out_validitiesThe validities of the texture parameters for each vertex at the specified index. If a vertex at a specified index had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_paramsThe texture parameters for each vertex at the specified index. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
out_param_widthThe number of texture parameters per vertex.
Returns
true if any specified vertex had a texture parameter set, false otherwise.

◆ ShowVertexParametersByRange() [1/2]

bool HPS::MeshKey::ShowVertexParametersByRange ( size_t  in_start,
size_t  in_count,
BoolArray out_validities,
FloatArray out_params 
) const

Shows the texture parameters on a range of vertices starting at the specified offset. For this particular show function, the parameter width is returned implicitly and could be determined by out_params.size()/in_count.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start showing texture parameters. This value must be such that in_start<point_count for showing to succeed.
in_countThe number of vertices for which to show the texture parameters.
out_validitiesThe validities of the texture parameters for each vertex in the specified range. If a vertex in the specified range had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_paramsThe texture parameters for each vertex in the specified range. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
Returns
true if any vertex in the specified range had a texture parameter set, false otherwise.

◆ ShowVertexParametersByRange() [2/2]

bool HPS::MeshKey::ShowVertexParametersByRange ( size_t  in_start,
size_t  in_count,
BoolArray out_validities,
FloatArray out_params,
size_t &  out_param_width 
) const

Shows the texture parameters on a range of vertices starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start showing texture parameters. This value must be such that in_start<point_count for showing to succeed.
in_countThe number of vertices for which to show the texture parameters.
out_validitiesThe validities of the texture parameters for each vertex in the specified range. If a vertex in the specified range had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_paramsThe texture parameters for each vertex in the specified range. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
out_param_widthThe number of texture parameters per vertex.
Returns
true if any vertex in the specified range had a texture parameter set, false otherwise.

◆ ShowVertexVisibilities()

bool HPS::MeshKey::ShowVertexVisibilities ( BoolArray out_validities,
BoolArray out_visibilities 
) const

Shows all the vertex visibilities on this MeshKey.

Parameters
out_validitiesThe validities of the visibilities for each vertex. If a vertex had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe vertex visibilities for each vertex. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any vertex had a vertex visibility set, false otherwise.

◆ ShowVertexVisibilitiesByList()

bool HPS::MeshKey::ShowVertexVisibilitiesByList ( SizeTArray const &  in_vertices,
BoolArray out_validities,
BoolArray out_visibilities 
) const

Shows the vertex visibilities on a selection of arbitrary vertices. The order of the values in the output arrays is the same as the input vertex index array, i.e., the values of out_validities[i] and out_visibilities[i] correspond to the vertex at index in_vertices[i].

Parameters
in_verticesThe indices of the vertices on which to show the normals.
out_validitiesThe validities of the normals for each vertex at the specified index. If a vertex at a specified index had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe vertex visibilities for each vertex at the specified index. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any specified vertex had a vertex visibility set, false otherwise.

◆ ShowVertexVisibilitiesByRange()

bool HPS::MeshKey::ShowVertexVisibilitiesByRange ( size_t  in_start,
size_t  in_count,
BoolArray out_validities,
BoolArray out_visibilities 
) const

Shows the vertex visibilities on a range of vertices starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start showing visibilities. This value must be such that in_start<point_count for showing to succeed.
in_countThe number of visibilities to show.
out_validitiesThe validities of the visibilities for each vertex in the specified range. If a vertex in the specified range had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe vertex visibilities for each vertex in the specified range. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any vertex in the specified range had a vertex visibility set, false otherwise.

◆ UnsetEdgeColors()

MeshKey& HPS::MeshKey::UnsetEdgeColors ( )

Unsets edge colors on all edges.

Parameters
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
out_typesThe types of edge colors for each edge.
out_rgb_colorsThe colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is Material::Type::RGBColor.
out_indicesThe colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is Material::Type::MaterialIndex.
Returns
A reference to this MeshKey.

◆ UnsetEdgeColorsByList() [1/2]

MeshKey& HPS::MeshKey::UnsetEdgeColorsByList ( SizeTArray const &  in_vertices1,
SizeTArray const &  in_vertices2 
)

Unsets edge colors on a selection of arbitrary edges.

Parameters
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
Returns
A reference to this MeshKey.

◆ UnsetEdgeColorsByList() [2/2]

MeshKey& HPS::MeshKey::UnsetEdgeColorsByList ( size_t  in_count,
size_t const  in_vertices1[],
size_t const  in_vertices2[] 
)

Unsets edge colors on a selection of arbitrary edges.

Parameters
in_countSize of the following arrays.
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
Returns
A reference to this MeshKey.

◆ UnsetEdgeEverything()

MeshKey& HPS::MeshKey::UnsetEdgeEverything ( )

Removes all edge settings (edge colors and edge visibilities) from this MeshKey.

Returns
A reference to this MeshKey.

◆ UnsetEdgeVisibilities()

MeshKey& HPS::MeshKey::UnsetEdgeVisibilities ( )

Removes all vertex visibilities.

Returns
A reference to this MeshKey.

◆ UnsetEdgeVisibilitiesByList() [1/2]

MeshKey& HPS::MeshKey::UnsetEdgeVisibilitiesByList ( SizeTArray const &  in_vertices1,
SizeTArray const &  in_vertices2 
)

Unsets edge visibilities on a selection of arbitrary edges.

Parameters
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being unset. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being unset. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
Returns
A reference to this MeshKey.

◆ UnsetEdgeVisibilitiesByList() [2/2]

MeshKey& HPS::MeshKey::UnsetEdgeVisibilitiesByList ( size_t  in_count,
size_t const  in_vertices1[],
size_t const  in_vertices2[] 
)

Unsets edge visibilities on a selection of arbitrary edges.

Parameters
in_countSize of the following arrays.
in_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being unset. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being unset. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
Returns
A reference to this MeshKey.

◆ UnsetEverything()

MeshKey& HPS::MeshKey::UnsetEverything ( )

Removes all settings from this MeshKey.

Returns
A reference to this MeshKey.

◆ UnsetFaceColors()

MeshKey& HPS::MeshKey::UnsetFaceColors ( )

Removes all face colors (RGB colors or material indices).

Returns
A reference to this MeshKey.

◆ UnsetFaceColorsByList() [1/2]

MeshKey& HPS::MeshKey::UnsetFaceColorsByList ( SizeTArray const &  in_faces)

Removes the face colors (RGB colors or material indices) on a selection of arbitrary vertices.

Parameters
in_facesThe indices of the faces on which to remove the colors.
Returns
A reference to this MeshKey.

◆ UnsetFaceColorsByList() [2/2]

MeshKey& HPS::MeshKey::UnsetFaceColorsByList ( size_t  in_count,
size_t const  in_faces[] 
)

Removes the face visibilities on a selection of arbitrary faces.

Parameters
in_countThe number of face visibilities to remove for this MeshKey.
in_facesThe indices of the faces on which to remove the visibilities.
Returns
A reference to this MeshKey.

◆ UnsetFaceColorsByRange()

MeshKey& HPS::MeshKey::UnsetFaceColorsByRange ( size_t  in_start,
size_t  in_count 
)

Removes the specified range of face colors (RGB colors or material indices) starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start removing colors. This value must be such that in_start<face_count for removal to succeed.
in_countThe number of face colors to unset for this MeshKey.
Returns
A reference to this MeshKey.

◆ UnsetFaceEverything()

MeshKey& HPS::MeshKey::UnsetFaceEverything ( )

Removes all face settings (face colors, face normals, and face visibilities) from this MeshKey.

Returns
A reference to this MeshKey.

◆ UnsetFaceNormals()

MeshKey& HPS::MeshKey::UnsetFaceNormals ( )

Removes all face normals.

Returns
A reference to this MeshKey.

◆ UnsetFaceNormalsByList()

MeshKey& HPS::MeshKey::UnsetFaceNormalsByList ( SizeTArray const &  in_faces)

Removes the face normals on a selection of arbitrary faces.

Parameters
in_facesThe indices of the faces on which to remove the normals.
Returns
A reference to this MeshKey.

◆ UnsetFaceNormalsByRange()

MeshKey& HPS::MeshKey::UnsetFaceNormalsByRange ( size_t  in_start,
size_t  in_count 
)

Removes the specified range of face normals starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start removing normals. This value must be such that in_start<face_count for removal to succeed.
in_countThe number of face normals to unset for this MeshKey.
Returns
A reference to this MeshKey.

◆ UnsetFaceVisibilities()

MeshKey& HPS::MeshKey::UnsetFaceVisibilities ( )

Removes all face visibilities.

Returns
A reference to this MeshKey.

◆ UnsetFaceVisibilitiesByList() [1/2]

MeshKey& HPS::MeshKey::UnsetFaceVisibilitiesByList ( size_t  in_count,
size_t const  in_faces[] 
)

Removes the face visibilities on a selection of arbitrary faces.

Parameters
in_countThe number of face visibilities to remove for this MeshKey.
in_facesThe indices of the faces on which to remove the visibilities.
Returns
A reference to this MeshKey.

◆ UnsetFaceVisibilitiesByList() [2/2]

MeshKey& HPS::MeshKey::UnsetFaceVisibilitiesByList ( SizeTArray const &  in_faces)

Removes the face visibilities on a selection of arbitrary faces.

Parameters
in_facesThe indices of the faces on which to remove the visibilities.
Returns
A reference to this MeshKey.

◆ UnsetFaceVisibilitiesByRange()

MeshKey& HPS::MeshKey::UnsetFaceVisibilitiesByRange ( size_t  in_start,
size_t  in_count 
)

Removes the specified range of face visibilities starting at the specified offset.

Parameters
in_startThe offset into the faces for this MeshKey at which to start removing visibilities. This value must be such that in_start<face_count for removal to succeed.
in_countThe number of face visibilities to unset for this MeshKey.
Returns
A reference to this MeshKey.

◆ UnsetMaterialMapping()

MeshKey& HPS::MeshKey::UnsetMaterialMapping ( )

Removes all material mappings on this MeshKey. This removes the "global" material settings and does not affect per-vertex or per-face materials.

Returns
A reference to this MeshKey.

◆ UnsetVertexColors() [1/2]

MeshKey& HPS::MeshKey::UnsetVertexColors ( )

Removes all vertex colors (RGB colors, RGBA colors, or material indices) for all mesh components.

Returns
A reference to this MeshKey.

◆ UnsetVertexColors() [2/2]

MeshKey& HPS::MeshKey::UnsetVertexColors ( Mesh::Component  in_apply_to)

Removes all vertex colors (RGB colors, RGBA colors, or material indices) for the specified mesh component.

Parameters
in_apply_toThe mesh component for which to remove the colors.
Returns
A reference to this MeshKey.

◆ UnsetVertexColorsByList() [1/4]

MeshKey& HPS::MeshKey::UnsetVertexColorsByList ( size_t  in_count,
size_t const  in_vertices[] 
)

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters
in_countThe number of vertex visibilities to remove for this MeshKey.
in_facesThe indices of the vertices on which to remove the visibilities.
Returns
A reference to this MeshKey.

◆ UnsetVertexColorsByList() [2/4]

MeshKey& HPS::MeshKey::UnsetVertexColorsByList ( size_t  in_count,
size_t const  in_vertices[],
Mesh::Component  in_apply_to 
)

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters
in_countThe number of vertex visibilities to remove for this MeshKey.
in_facesThe indices of the vertices on which to remove the visibilities.
in_apply_toThe shell component the colors should apply to.
Returns
A reference to this MeshKey.

◆ UnsetVertexColorsByList() [3/4]

MeshKey& HPS::MeshKey::UnsetVertexColorsByList ( SizeTArray const &  in_vertices)

Removes the vertex colors (RGB colors, RGBA colors, or material indices) for all mesh components on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to remove the colors.
Returns
A reference to this MeshKey.

◆ UnsetVertexColorsByList() [4/4]

MeshKey& HPS::MeshKey::UnsetVertexColorsByList ( SizeTArray const &  in_vertices,
Mesh::Component  in_apply_to 
)

Removes the vertex colors (RGB colors, RGBA colors, or material indices) for the specificed mesh component on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to remove the colors.
in_apply_toThe mesh component for which to remove the colors.
Returns
A reference to this MeshKey.

◆ UnsetVertexColorsByRange() [1/2]

MeshKey& HPS::MeshKey::UnsetVertexColorsByRange ( size_t  in_start,
size_t  in_count 
)

Removes the specified range of vertex colors (RGB colors, RGBA colors, or material indices) for all mesh components starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start removing colors. This value must be such that in_start<point_count for removal to succeed.
in_countThe number of vertex colors to unset for this MeshKey.
Returns
A reference to this MeshKey.

◆ UnsetVertexColorsByRange() [2/2]

MeshKey& HPS::MeshKey::UnsetVertexColorsByRange ( size_t  in_start,
size_t  in_count,
Mesh::Component  in_apply_to 
)

Removes the specified range of vertex colors (RGB colors, RGBA colors, or material indices) for the specified mesh component starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start removing colors. This value must be such that in_start<point_count for removal to succeed.
in_countThe number of vertex colors to unset for this MeshKey.
in_apply_toThe mesh component for which to remove the colors.
Returns
A reference to this MeshKey.

◆ UnsetVertexEverything()

MeshKey& HPS::MeshKey::UnsetVertexEverything ( )

Removes all vertex settings (vertex colors, vertex normals, texture parameters, and vertex visibilities) from this MeshKey.

Returns
A reference to this MeshKey.

◆ UnsetVertexNormals()

MeshKey& HPS::MeshKey::UnsetVertexNormals ( )

Removes all vertex normals.

Returns
A reference to this MeshKey.

◆ UnsetVertexNormalsByList()

MeshKey& HPS::MeshKey::UnsetVertexNormalsByList ( SizeTArray const &  in_vertices)

Removes the vertex normals on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to remove the normals.
Returns
A reference to this MeshKey.

◆ UnsetVertexNormalsByRange()

MeshKey& HPS::MeshKey::UnsetVertexNormalsByRange ( size_t  in_start,
size_t  in_count 
)

Removes the specified range of vertex normals starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start removing normals. This value must be such that in_start<point_count for removal to succeed.
in_countThe number of vertex normals to unset for this MeshKey.
Returns
A reference to this MeshKey.

◆ UnsetVertexParameters()

MeshKey& HPS::MeshKey::UnsetVertexParameters ( )

Removes all texture parameters.

Returns
A reference to this MeshKey.

◆ UnsetVertexParametersByList()

MeshKey& HPS::MeshKey::UnsetVertexParametersByList ( SizeTArray const &  in_vertices)

Removes the texture parameters on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to remove the texture parameters.
Returns
A reference to this MeshKey.

◆ UnsetVertexParametersByRange()

MeshKey& HPS::MeshKey::UnsetVertexParametersByRange ( size_t  in_start,
size_t  in_count 
)

Removes the specified range of texture parameters starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start removing texture parameters. This value must be such that in_start<point_count for removal to succeed.
in_countThe number of texture parameters to unset for this MeshKey.
Returns
A reference to this MeshKey.

◆ UnsetVertexVisibilities()

MeshKey& HPS::MeshKey::UnsetVertexVisibilities ( )

Removes all vertex visibilities.

Returns
A reference to this MeshKey.

◆ UnsetVertexVisibilitiesByList() [1/2]

MeshKey& HPS::MeshKey::UnsetVertexVisibilitiesByList ( size_t  in_count,
size_t const  in_vertices[] 
)

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters
in_countThe number of vertex visibilities to remove for this MeshKey.
in_facesThe indices of the vertices on which to remove the visibilities.
Returns
A reference to this MeshKey.

◆ UnsetVertexVisibilitiesByList() [2/2]

MeshKey& HPS::MeshKey::UnsetVertexVisibilitiesByList ( SizeTArray const &  in_vertices)

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to remove the visibilities.
Returns
A reference to this MeshKey.

◆ UnsetVertexVisibilitiesByRange()

MeshKey& HPS::MeshKey::UnsetVertexVisibilitiesByRange ( size_t  in_start,
size_t  in_count 
)

Removes the specified range of vertex visibilities starting at the specified offset.

Parameters
in_startThe offset into the vertices for this MeshKey at which to start removing visibilities. This value must be such that in_start<point_count for removal to succeed.
in_countThe number of vertex visibilities to unset for this MeshKey.
Returns
A reference to this MeshKey.

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