#include <hps.h>

Inheritance diagram for HPS::MeshKit:
HPS::Kit HPS::Object

Public Member Functions

void Consume (MeshKit &in_kit)
 
bool Empty () const
 
bool Equals (MeshKit const &in_kit) const
 
size_t GetPointCount () const
 
 MeshKit ()
 
 MeshKit (MeshKit const &in_kit)
 
 MeshKit (MeshKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (MeshKit const &in_kit) const
 
MeshKitoperator= (MeshKit &&in_that)
 
MeshKitoperator= (MeshKit const &in_kit)
 
bool operator== (MeshKit const &in_kit) const
 
void Set (MeshKit const &in_kit)
 
MeshKitSetColumns (size_t in_columns)
 
MeshKitSetEdgeIndexColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, FloatArray const &in_indices)
 
MeshKitSetEdgeIndexColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, float in_index)
 
MeshKitSetEdgeIndexColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], float const in_indices[])
 
MeshKitSetEdgeIndexColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], float in_index)
 
MeshKitSetEdgeRGBColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, RGBColorArray const &in_rgb_colors)
 
MeshKitSetEdgeRGBColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, RGBColor const &in_rgb_color)
 
MeshKitSetEdgeRGBColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], RGBColor const in_rgb_colors[])
 
MeshKitSetEdgeRGBColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], RGBColor const in_rgb_color)
 
MeshKitSetEdgeVisibilitiesByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], bool const in_visibilities[])
 
MeshKitSetEdgeVisibilitiesByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], bool in_visibility)
 
MeshKitSetEdgeVisibilitiesByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, bool in_visibility)
 
MeshKitSetEdgeVisibilitiesByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, BoolArray const &in_visibilities)
 
MeshKitSetFaceIndexColorsByList (size_t in_count, size_t const in_faces[], float const in_indices[])
 
MeshKitSetFaceIndexColorsByList (SizeTArray const &in_faces, FloatArray const &in_indices)
 
MeshKitSetFaceIndexColorsByList (size_t in_count, size_t const in_faces[], float in_index)
 
MeshKitSetFaceIndexColorsByList (SizeTArray const &in_faces, float in_index)
 
MeshKitSetFaceIndexColorsByRange (size_t in_start, size_t in_count, float const in_indices[])
 
MeshKitSetFaceIndexColorsByRange (size_t in_start, FloatArray const &in_indices)
 
MeshKitSetFaceIndexColorsByRange (size_t in_start, size_t in_count, float in_index)
 
MeshKitSetFaceNormalsByList (size_t in_count, size_t const in_faces[], Vector const in_normals[])
 
MeshKitSetFaceNormalsByList (SizeTArray const &in_faces, VectorArray const &in_normals)
 
MeshKitSetFaceNormalsByList (size_t in_count, size_t const in_faces[], Vector const &in_normal)
 
MeshKitSetFaceNormalsByList (SizeTArray const &in_faces, Vector const &in_normal)
 
MeshKitSetFaceNormalsByRange (size_t in_start, size_t in_count, Vector const in_normals[])
 
MeshKitSetFaceNormalsByRange (size_t in_start, VectorArray const &in_normals)
 
MeshKitSetFaceNormalsByRange (size_t in_start, size_t in_count, Vector const &in_normal)
 
MeshKitSetFaceRGBColorsByList (size_t in_count, size_t const in_faces[], RGBColor const in_rgb_colors[])
 
MeshKitSetFaceRGBColorsByList (SizeTArray const &in_faces, RGBColorArray const &in_rgb_colors)
 
MeshKitSetFaceRGBColorsByList (size_t in_count, size_t const in_faces[], RGBColor const &in_rgb_color)
 
MeshKitSetFaceRGBColorsByList (SizeTArray const &in_faces, RGBColor const &in_rgb_color)
 
MeshKitSetFaceRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const in_rgb_colors[])
 
MeshKitSetFaceRGBColorsByRange (size_t in_start, RGBColorArray const &in_rgb_colors)
 
MeshKitSetFaceRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const &in_rgb_color)
 
MeshKitSetFaceVisibilitiesByList (size_t in_count, size_t const in_faces[], bool const in_visibilities[])
 
MeshKitSetFaceVisibilitiesByList (SizeTArray const &in_faces, BoolArray const &in_visibilities)
 
MeshKitSetFaceVisibilitiesByList (size_t in_count, size_t const in_faces[], bool in_visibility)
 
MeshKitSetFaceVisibilitiesByList (SizeTArray const &in_faces, bool in_visibility)
 
MeshKitSetFaceVisibilitiesByRange (size_t in_start, size_t in_count, bool const in_visibilities[])
 
MeshKitSetFaceVisibilitiesByRange (size_t in_start, BoolArray const &in_visibilities)
 
MeshKitSetFaceVisibilitiesByRange (size_t in_start, size_t in_count, bool in_visibility)
 
MeshKitSetMaterialMapping (MaterialMappingKit const &in_kit)
 
MeshKitSetPoints (PointArray const &in_points)
 
MeshKitSetPoints (size_t in_count, Point const in_points [])
 
MeshKitSetPoints (size_t in_rows, size_t in_columns, HPS::PointArray const &in_points)
 
MeshKitSetPoints (size_t in_rows, size_t in_columns, size_t in_count, Point const in_points [])
 
MeshKitSetPriority (int in_priority)
 
MeshKitSetRows (size_t in_rows)
 
MeshKitSetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
 
MeshKitSetUserData (intptr_t in_index, ByteArray const &in_data)
 
MeshKitSetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
 
MeshKitSetVertexIndexColorsByList (size_t in_count, size_t const in_vertices[], float const in_indices[], Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexIndexColorsByList (SizeTArray const &in_vertices, FloatArray const &in_indices, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexIndexColorsByList (size_t in_count, size_t const in_vertices[], float in_index, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexIndexColorsByList (SizeTArray const &in_vertices, float in_index, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexIndexColorsByRange (size_t in_start, size_t in_count, float const in_indices[], Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexIndexColorsByRange (size_t in_start, FloatArray const &in_indices, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexIndexColorsByRange (size_t in_start, size_t in_count, float in_index, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexNormalsByList (size_t in_count, size_t const in_vertices[], Vector const in_normals[])
 
MeshKitSetVertexNormalsByList (SizeTArray const &in_vertices, VectorArray const &in_normals)
 
MeshKitSetVertexNormalsByList (size_t in_count, size_t const in_vertices[], Vector const &in_normal)
 
MeshKitSetVertexNormalsByList (SizeTArray const &in_vertices, Vector const &in_normal)
 
MeshKitSetVertexNormalsByRange (size_t in_start, size_t in_count, Vector const in_normals[])
 
MeshKitSetVertexNormalsByRange (size_t in_start, VectorArray const &in_normals)
 
MeshKitSetVertexNormalsByRange (size_t in_start, size_t in_count, Vector const &in_normal)
 
MeshKitSetVertexParametersByList (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)
 
MeshKitSetVertexParametersByList (SizeTArray const &in_vertices, FloatArray const &in_params, size_t in_param_width=2)
 
MeshKitSetVertexParametersByRange (size_t in_start, size_t in_param_count, float const in_params[], size_t in_param_width=2)
 
MeshKitSetVertexParametersByRange (size_t in_start, FloatArray const &in_params, size_t in_param_width=2)
 
MeshKitSetVertexRGBAColorsByList (size_t in_count, size_t const in_vertices[], RGBAColor const in_rgba_colors[], Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexRGBAColorsByList (SizeTArray const &in_vertices, RGBAColorArray const &in_rgba_colors, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexRGBAColorsByList (size_t in_count, size_t const in_vertices[], RGBAColor const &in_rgba_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexRGBAColorsByList (SizeTArray const &in_vertices, RGBAColor const &in_rgba_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexRGBAColorsByRange (size_t in_start, size_t in_count, RGBAColor const in_rgba_colors[], Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexRGBAColorsByRange (size_t in_start, RGBAColorArray const &in_rgba_colors, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexRGBAColorsByRange (size_t in_start, size_t in_count, RGBAColor const &in_rgba_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexRGBColorsByList (size_t in_count, size_t const in_vertices[], RGBColor const in_rgb_colors[], Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexRGBColorsByList (SizeTArray const &in_vertices, RGBColorArray const &in_rgb_colors, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexRGBColorsByList (size_t in_count, size_t const in_vertices[], RGBColor const &in_rgb_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexRGBColorsByList (SizeTArray const &in_vertices, RGBColor const &in_rgb_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const in_rgb_colors[], Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexRGBColorsByRange (size_t in_start, RGBColorArray const &in_rgb_colors, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const &in_rgb_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
 
MeshKitSetVertexVisibilitiesByList (size_t in_count, size_t const in_vertices[], bool const in_visibilities[])
 
MeshKitSetVertexVisibilitiesByList (SizeTArray const &in_vertices, BoolArray const &in_visibilities)
 
MeshKitSetVertexVisibilitiesByList (size_t in_count, size_t const in_vertices[], bool in_visibility)
 
MeshKitSetVertexVisibilitiesByList (SizeTArray const &in_vertices, bool in_visibility)
 
MeshKitSetVertexVisibilitiesByRange (size_t in_start, size_t in_count, bool const in_visibilities[])
 
MeshKitSetVertexVisibilitiesByRange (size_t in_start, BoolArray const &in_visibilities)
 
MeshKitSetVertexVisibilitiesByRange (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 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 ShowPriority (int &out_priority) const
 
bool ShowRows (size_t &out_rows) 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
 
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
 
MeshKitUnsetAllUserData ()
 
MeshKitUnsetColumns ()
 
MeshKitUnsetEdgeColors ()
 
MeshKitUnsetEdgeColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2)
 
MeshKitUnsetEdgeColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[])
 
MeshKitUnsetEdgeEverything ()
 
MeshKitUnsetEdgeVisibilities ()
 
MeshKitUnsetEdgeVisibilitiesByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2)
 
MeshKitUnsetEdgeVisibilitiesByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[])
 
MeshKitUnsetEverything ()
 
MeshKitUnsetFaceColors ()
 
MeshKitUnsetFaceColorsByList (SizeTArray const &in_vertices)
 
MeshKitUnsetFaceColorsByList (size_t in_count, size_t const in_faces[])
 
MeshKitUnsetFaceColorsByRange (size_t in_start, size_t in_count)
 
MeshKitUnsetFaceEverything ()
 
MeshKitUnsetFaceNormals ()
 
MeshKitUnsetFaceNormalsByList (SizeTArray const &in_vertices)
 
MeshKitUnsetFaceNormalsByRange (size_t in_start, size_t in_count)
 
MeshKitUnsetFaceVisibilities ()
 
MeshKitUnsetFaceVisibilitiesByList (size_t in_count, size_t const in_faces[])
 
MeshKitUnsetFaceVisibilitiesByList (SizeTArray const &in_vertices)
 
MeshKitUnsetFaceVisibilitiesByRange (size_t in_start, size_t in_count)
 
MeshKitUnsetMaterialMapping ()
 
MeshKitUnsetPoints ()
 
MeshKitUnsetPriority ()
 
MeshKitUnsetRows ()
 
MeshKitUnsetUserData (intptr_t in_index)
 
MeshKitUnsetUserData (size_t in_count, intptr_t const in_indices[])
 
MeshKitUnsetUserData (IntPtrTArray const &in_indices)
 
MeshKitUnsetVertexColors ()
 
MeshKitUnsetVertexColors (Mesh::Component in_apply_to)
 
MeshKitUnsetVertexColorsByList (size_t in_count, size_t const in_vertices[])
 
MeshKitUnsetVertexColorsByList (size_t in_count, size_t const in_vertices[], Mesh::Component in_apply_to)
 
MeshKitUnsetVertexColorsByList (SizeTArray const &in_vertices)
 
MeshKitUnsetVertexColorsByList (SizeTArray const &in_vertices, Mesh::Component in_apply_to)
 
MeshKitUnsetVertexColorsByRange (size_t in_start, size_t in_count)
 
MeshKitUnsetVertexColorsByRange (size_t in_start, size_t in_count, Mesh::Component in_apply_to)
 
MeshKitUnsetVertexEverything ()
 
MeshKitUnsetVertexNormals ()
 
MeshKitUnsetVertexNormalsByList (SizeTArray const &in_vertices)
 
MeshKitUnsetVertexNormalsByRange (size_t in_start, size_t in_count)
 
MeshKitUnsetVertexParameters ()
 
MeshKitUnsetVertexParametersByList (SizeTArray const &in_vertices)
 
MeshKitUnsetVertexParametersByRange (size_t in_start, size_t in_count)
 
MeshKitUnsetVertexVisibilities ()
 
MeshKitUnsetVertexVisibilitiesByList (size_t in_count, size_t const in_vertices[])
 
MeshKitUnsetVertexVisibilitiesByList (SizeTArray const &in_vertices)
 
MeshKitUnsetVertexVisibilitiesByRange (size_t in_start, size_t in_count)
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
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 ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::MeshKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- 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 ()
 
- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

The MeshKit class is a user space object. It is a kit analog to a MeshKey.

Constructor & Destructor Documentation

◆ MeshKit() [1/3]

HPS::MeshKit::MeshKit ( )

The default constructor creates an empty MeshKit object.

◆ MeshKit() [2/3]

HPS::MeshKit::MeshKit ( MeshKit const &  in_kit)

The copy constructor creates a new MeshKit object that contains the same settings as the source MeshKit.

Parameters
in_kitThe source MeshKit to copy.

◆ MeshKit() [3/3]

HPS::MeshKit::MeshKit ( MeshKit &&  in_that)

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

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

Member Function Documentation

◆ Consume()

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

Copies the source MeshKit into this MeshKit and resets the source kit.

Parameters
in_kitThe source MeshKit to consume.

◆ Empty()

bool HPS::MeshKit::Empty ( ) const
virtual

Indicates whether this MeshKit has any values set on it.

Returns
true if no values are set on this MeshKit, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::MeshKit::Equals ( MeshKit const &  in_kit) const

Check if the source MeshKit is equivalent to this MeshKit.

Parameters
in_kitThe source MeshKit to compare to this MeshKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetPointCount()

size_t HPS::MeshKit::GetPointCount ( ) const

Retrieves the number of points in this mesh.

Returns
The number of points in this mesh.

◆ ObjectType()

HPS::Type HPS::MeshKit::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::Kit.

◆ operator!=()

bool HPS::MeshKit::operator!= ( MeshKit const &  in_kit) const

Check if the source MeshKit is not equivalent to this MeshKit.

Parameters
in_kitThe source MeshKit to compare to this MeshKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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

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

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

◆ operator=() [2/2]

MeshKit& HPS::MeshKit::operator= ( MeshKit const &  in_kit)

Copies the source MeshKit into this MeshKit.

Parameters
in_kitThe source MeshKit to copy.
Returns
A reference to this MeshKit.

◆ operator==()

bool HPS::MeshKit::operator== ( MeshKit const &  in_kit) const

Check if the source MeshKit is equivalent to this MeshKit.

Parameters
in_kitThe source MeshKit to compare to this MeshKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

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

Copies the source MeshKit into this MeshKit.

Parameters
in_kitThe source MeshKit to copy.

◆ SetColumns()

MeshKit& HPS::MeshKit::SetColumns ( size_t  in_columns)

Sets the number of columns for this MeshKit.

Parameters
in_columnsThe number of columns for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetEdgeIndexColorsByList() [1/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetEdgeIndexColorsByList() [2/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetEdgeIndexColorsByList() [3/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetEdgeIndexColorsByList() [4/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetEdgeRGBColorsByList() [1/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetEdgeRGBColorsByList() [2/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetEdgeRGBColorsByList() [3/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetEdgeRGBColorsByList() [4/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetEdgeVisibilitiesByList() [1/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetEdgeVisibilitiesByList() [2/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetEdgeVisibilitiesByList() [3/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetEdgeVisibilitiesByList() [4/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceIndexColorsByList() [1/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceIndexColorsByList() [2/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceIndexColorsByList() [3/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceIndexColorsByList() [4/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceIndexColorsByRange() [1/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting colors.
in_countSize of the following array.
in_indicesThe material indices to set on the faces for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetFaceIndexColorsByRange() [2/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting colors.
in_indicesThe material indices to set on the faces for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetFaceIndexColorsByRange() [3/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting the color.
in_countThe number of faces on which to set the color.
in_indexThe material index to set on the faces for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetFaceNormalsByList() [1/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceNormalsByList() [2/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceNormalsByList() [3/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceNormalsByList() [4/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceNormalsByRange() [1/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting normals.
in_countSize of the following array.
in_normalsThe normals to set on the faces for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetFaceNormalsByRange() [2/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting normals.
in_normalsThe normals to set on the faces for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetFaceNormalsByRange() [3/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting the normal.
in_countThe number of faces on which to set the normal.
in_normalThe normal to set on the faces for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetFaceRGBColorsByList() [1/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceRGBColorsByList() [2/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceRGBColorsByList() [3/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceRGBColorsByList() [4/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceRGBColorsByRange() [1/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting colors.
in_countSize of the following array.
in_rgb_colorsThe RGB colors to set on the faces for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetFaceRGBColorsByRange() [2/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting colors.
in_rgb_colorsThe RGB colors to set on the faces for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetFaceRGBColorsByRange() [3/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting the color.
in_countThe number of faces on which to set the color.
in_rgb_colorThe RGB color to set on the faces for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetFaceVisibilitiesByList() [1/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceVisibilitiesByList() [2/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceVisibilitiesByList() [3/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceVisibilitiesByList() [4/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetFaceVisibilitiesByRange() [1/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting visibilities.
in_countSize of the following array.
in_visibilitiesThe visibilities to set on the faces for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetFaceVisibilitiesByRange() [2/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting visibilities.
in_visibilitiesThe visibilities to set on the faces for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetFaceVisibilitiesByRange() [3/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting the visibility.
in_countThe number of faces on which to set the visibility.
in_visibilityThe visibility to set on the faces for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetMaterialMapping()

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

Sets the specified material mappings on this MeshKit. If this kit is used to insert a mesh, only face, back face, cut edge, cut face, edge, and vertex materials will be set on the inserted 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/4]

MeshKit& HPS::MeshKit::SetPoints ( PointArray const &  in_points)

Sets the points for this MeshKit.

Parameters
in_pointsThe points for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetPoints() [2/4]

MeshKit& HPS::MeshKit::SetPoints ( size_t  in_count,
Point const  in_points[] 
)

Sets the points for this MeshKit.

Parameters
in_countSize of the following array.
in_pointsThe points for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetPoints() [3/4]

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

Sets the points, rows and columns for this MeshKit.

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

◆ SetPoints() [4/4]

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

Sets the points, rows and columns for this MeshKit.

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

◆ SetPriority()

MeshKit& HPS::MeshKit::SetPriority ( int  in_priority)

Assigns a specific drawing priority value to the MeshKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.

Parameters
in_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.
See also
SubwindowKit::SetPriority()
SubwindowKit::SetRenderingAlgorithm()

◆ SetRows()

MeshKit& HPS::MeshKit::SetRows ( size_t  in_rows)

Sets the number of rows for this MeshKit.

Parameters
in_rowsThe number of rows for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetUserData() [1/3]

MeshKit& HPS::MeshKit::SetUserData ( intptr_t  in_index,
size_t  in_bytes,
byte const  in_data[] 
)

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [2/3]

MeshKit& HPS::MeshKit::SetUserData ( intptr_t  in_index,
ByteArray const &  in_data 
)

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [3/3]

MeshKit& HPS::MeshKit::SetUserData ( IntPtrTArray const &  in_indices,
ByteArrayArray const &  in_data 
)

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.

◆ SetVertexIndexColorsByList() [1/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexIndexColorsByList() [2/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexIndexColorsByList() [3/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexIndexColorsByList() [4/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexIndexColorsByRange() [1/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting colors.
in_countSize of the following array.
in_indicesThe material indices to set on the vertices for this MeshKit.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKit.

◆ SetVertexIndexColorsByRange() [2/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting colors.
in_indicesThe material indices to set on the vertices for this MeshKit.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKit.

◆ SetVertexIndexColorsByRange() [3/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting the color.
in_countThe number of vertices on which to set the color.
in_indexThe material index to set on the vertices for this MeshKit.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKit.

◆ SetVertexNormalsByList() [1/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexNormalsByList() [2/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexNormalsByList() [3/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexNormalsByList() [4/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexNormalsByRange() [1/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting normals.
in_countSize of the following array.
in_normalsThe normals to set on the vertices for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetVertexNormalsByRange() [2/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting normals.
in_normalsThe normals to set on the vertices for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetVertexNormalsByRange() [3/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting the normal.
in_countThe number of vertices on which to set the normal.
in_normalThe normal to set on the vertices for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetVertexParametersByList() [1/2]

MeshKit& HPS::MeshKit::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 MeshKit.
in_param_widthThe number of texture parameters per vertex. Defaults to 2.
Returns
A reference to this MeshKit.

◆ SetVertexParametersByList() [2/2]

MeshKit& HPS::MeshKit::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 MeshKit. 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 MeshKit.

◆ SetVertexParametersByRange() [1/2]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting 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 MeshKit.
in_param_widthThe number of texture parameters per vertex. Defaults to 2.
Returns
A reference to this MeshKit.

◆ SetVertexParametersByRange() [2/2]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting texture parameters.
in_paramsThe texture parameters to set on the vertices for this MeshKit. 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 MeshKit.

◆ SetVertexRGBAColorsByList() [1/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexRGBAColorsByList() [2/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexRGBAColorsByList() [3/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexRGBAColorsByList() [4/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexRGBAColorsByRange() [1/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting colors.
in_countSize of the following array.
in_rgba_colorsThe RGBA colors to set on the vertices for this MeshKit.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKit.

◆ SetVertexRGBAColorsByRange() [2/3]

MeshKit& HPS::MeshKit::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.
in_rgba_colorsThe RGBA colors to set on the vertices for this MeshKit.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKit.

◆ SetVertexRGBAColorsByRange() [3/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting the color.
in_countThe number of vertices on which to set the color.
in_rgba_colorThe RGBA color to set on the vertices for this MeshKit.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKit.

◆ SetVertexRGBColorsByList() [1/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexRGBColorsByList() [2/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexRGBColorsByList() [3/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexRGBColorsByList() [4/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexRGBColorsByRange() [1/3]

MeshKit& HPS::MeshKit::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.
in_countSize of the following array.
in_rgb_colorsThe RGB colors to set on the vertices for this MeshKit.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKit.

◆ SetVertexRGBColorsByRange() [2/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting colors.
in_rgb_colorsThe RGB colors to set on the vertices for this MeshKit.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKit.

◆ SetVertexRGBColorsByRange() [3/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting the color.
in_countThe number of vertices on which to set the color.
in_rgb_colorThe RGB color to set on the vertices for this MeshKit.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKit.

◆ SetVertexVisibilitiesByList() [1/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexVisibilitiesByList() [2/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexVisibilitiesByList() [3/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexVisibilitiesByList() [4/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ SetVertexVisibilitiesByRange() [1/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting visibilities.
in_countSize of the following array.
in_visibilitiesThe visibilities to set on the vertices for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetVertexVisibilitiesByRange() [2/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting visibilities.
in_visibilitiesThe visibilities to set on the vertices for this MeshKit.
Returns
A reference to this MeshKit.

◆ SetVertexVisibilitiesByRange() [3/3]

MeshKit& HPS::MeshKit::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 MeshKit at which to start setting the visibility.
in_countThe number of vertices on which to set the visibility.
in_visibilityThe visibility to set on the vertices for this MeshKit.
Returns
A reference to this MeshKit.

◆ Show()

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

Copies this MeshKit into the given MeshKit.

Parameters
out_kitThe MeshKit to populate with the contents of this MeshKit.

◆ ShowColumns()

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

Shows the number of columns for this MeshKit.

Parameters
out_columnsThe number of columns for this MeshKit.
Returns
true if a number of columns was set, false otherwise.

◆ ShowEdgeColors()

bool HPS::MeshKit::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 MeshKit.

◆ ShowEdgeColorsByList()

bool HPS::MeshKit::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 MeshKit.

◆ ShowEdgeVisibilitiesByList()

bool HPS::MeshKit::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::MeshKit::ShowFaceColors ( MaterialTypeArray out_types,
RGBColorArray out_rgb_colors,
FloatArray out_indices 
) const

Shows all the face colors on this MeshKit.

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::MeshKit::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::MeshKit::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 MeshKit at which to start showing colors.
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::MeshKit::ShowFaceNormals ( BoolArray out_validities,
VectorArray out_normals 
) const

Shows the all face normals on this MeshKit.

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::MeshKit::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::MeshKit::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 MeshKit at which to start showing normals.
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::MeshKit::ShowFaceVisibilities ( BoolArray out_validities,
BoolArray out_visibilities 
) const

Shows all the face visibilities on this MeshKit.

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 for 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::MeshKit::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::MeshKit::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 MeshKit at which to start showing visibilities.
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::MeshKit::ShowMaterialMapping ( MaterialMappingKit out_kit) const

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

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

◆ ShowPoints() [1/2]

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

Shows the points for this MeshKit.

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

◆ ShowPoints() [2/2]

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

Shows the number of rows, number of columns, and points for this MeshKit.

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

◆ ShowPointsByList() [1/2]

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

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

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

◆ ShowPointsByList() [2/2]

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

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

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

◆ ShowPointsByRange()

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

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

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

◆ ShowPriority()

bool HPS::MeshKit::ShowPriority ( int &  out_priority) const

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if the setting is valid, false otherwise.

◆ ShowRows()

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

Shows the number of rows for this MeshKit.

Parameters
out_rowsThe number of rows for this MeshKit.
Returns
true if a number of rows was set, false otherwise.

◆ ShowUserData() [1/2]

bool HPS::MeshKit::ShowUserData ( intptr_t  in_index,
ByteArray out_data 
) const

Shows the user data at a given index for this kit.

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.

◆ ShowUserData() [2/2]

bool HPS::MeshKit::ShowUserData ( IntPtrTArray out_indices,
ByteArrayArray out_data 
) const

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn array of all user data set on this kit.
Returns
true if there is user data on this kit, false otherwise.

◆ ShowUserDataCount()

size_t HPS::MeshKit::ShowUserDataCount ( ) const

Get the number of user data indices set on this kit.

◆ ShowUserDataIndices()

bool HPS::MeshKit::ShowUserDataIndices ( IntPtrTArray out_indices) const

Shows the indices of all user data set on this kit.

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.

◆ ShowVertexColors()

bool HPS::MeshKit::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::MeshKit::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::MeshKit::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 MeshKit at which to start showing colors.
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::MeshKit::ShowVertexNormals ( BoolArray out_validities,
VectorArray out_normals 
) const

Shows all the vertex normals on this MeshKit.

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::MeshKit::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::MeshKit::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 MeshKit at which to start showing normals.
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::MeshKit::ShowVertexParameters ( BoolArray out_validities,
FloatArray out_params 
) const

Shows the texture parameters for all of the vertices starting in this MeshKit. 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::MeshKit::ShowVertexParameters ( BoolArray out_validities,
FloatArray out_params,
size_t &  out_param_width 
) const

Shows the texture parameters for all of the vertices starting in this MeshKit.

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::MeshKit::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::MeshKit::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::MeshKit::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 MeshKit at which to start showing texture parameters.
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::MeshKit::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 MeshKit at which to start showing texture parameters.
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::MeshKit::ShowVertexVisibilities ( BoolArray out_validities,
BoolArray out_visibilities 
) const

Shows all the vertex visibilities on this MeshKit.

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::MeshKit::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::MeshKit::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 MeshKit at which to start showing visibilities.
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.

◆ UnsetAllUserData()

MeshKit& HPS::MeshKit::UnsetAllUserData ( )

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetColumns()

MeshKit& HPS::MeshKit::UnsetColumns ( )

Removes the number of columns for this MeshKit.

Returns
A reference to this MeshKit.

◆ UnsetEdgeColors()

MeshKit& HPS::MeshKit::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 MeshKit.

◆ UnsetEdgeColorsByList() [1/2]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ UnsetEdgeColorsByList() [2/2]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ UnsetEdgeEverything()

MeshKit& HPS::MeshKit::UnsetEdgeEverything ( )

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

Returns
A reference to this MeshKit.

◆ UnsetEdgeVisibilities()

MeshKit& HPS::MeshKit::UnsetEdgeVisibilities ( )

Removes all vertex visibilities.

Returns
A reference to this MeshKit.

◆ UnsetEdgeVisibilitiesByList() [1/2]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ UnsetEdgeVisibilitiesByList() [2/2]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ UnsetEverything()

MeshKit& HPS::MeshKit::UnsetEverything ( )

Removes all settings from this MeshKit.

Returns
A reference to this MeshKit.

◆ UnsetFaceColors()

MeshKit& HPS::MeshKit::UnsetFaceColors ( )

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

Returns
A reference to this MeshKit.

◆ UnsetFaceColorsByList() [1/2]

MeshKit& HPS::MeshKit::UnsetFaceColorsByList ( SizeTArray const &  in_vertices)

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

Parameters
in_verticesThe indices of the faces on which to remove the colors.
Returns
A reference to this MeshKit.

◆ UnsetFaceColorsByList() [2/2]

MeshKit& HPS::MeshKit::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 MeshKit.
in_facesThe indices of the faces on which to remove the visibilities.
Returns
A reference to this MeshKit.

◆ UnsetFaceColorsByRange()

MeshKit& HPS::MeshKit::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 MeshKit at which to start removing colors.
in_countThe number of face colors to unset for this MeshKit.
Returns
A reference to this MeshKit.

◆ UnsetFaceEverything()

MeshKit& HPS::MeshKit::UnsetFaceEverything ( )

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

Returns
A reference to this MeshKit.

◆ UnsetFaceNormals()

MeshKit& HPS::MeshKit::UnsetFaceNormals ( )

Removes all face normals.

Returns
A reference to this MeshKit.

◆ UnsetFaceNormalsByList()

MeshKit& HPS::MeshKit::UnsetFaceNormalsByList ( SizeTArray const &  in_vertices)

Removes the face normals on a selection of arbitrary faces.

Parameters
in_verticesThe indices of the faces on which to remove the normals.
Returns
A reference to this MeshKit.

◆ UnsetFaceNormalsByRange()

MeshKit& HPS::MeshKit::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 MeshKit at which to start removing normals.
in_countThe number of face normals to unset for this MeshKit.
Returns
A reference to this MeshKit.

◆ UnsetFaceVisibilities()

MeshKit& HPS::MeshKit::UnsetFaceVisibilities ( )

Removes all face visibilities.

Returns
A reference to this MeshKit.

◆ UnsetFaceVisibilitiesByList() [1/2]

MeshKit& HPS::MeshKit::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 MeshKit.
in_facesThe indices of the faces on which to remove the visibilities.
Returns
A reference to this MeshKit.

◆ UnsetFaceVisibilitiesByList() [2/2]

MeshKit& HPS::MeshKit::UnsetFaceVisibilitiesByList ( SizeTArray const &  in_vertices)

Removes the face visibilities on a selection of arbitrary faces.

Parameters
in_verticesThe indices of the faces on which to remove the visibilities.
Returns
A reference to this MeshKit.

◆ UnsetFaceVisibilitiesByRange()

MeshKit& HPS::MeshKit::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 MeshKit at which to start removing visibilities.
in_countThe number of face visibilities to unset for this MeshKit.
Returns
A reference to this MeshKit.

◆ UnsetMaterialMapping()

MeshKit& HPS::MeshKit::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 MeshKit.

◆ UnsetPoints()

MeshKit& HPS::MeshKit::UnsetPoints ( )

Removes the points for this MeshKit.

Returns
A reference to this MeshKit.

◆ UnsetPriority()

MeshKit& HPS::MeshKit::UnsetPriority ( )

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetRows()

MeshKit& HPS::MeshKit::UnsetRows ( )

Removes the number of rows for this MeshKit.

Returns
A reference to this MeshKit.

◆ UnsetUserData() [1/3]

MeshKit& HPS::MeshKit::UnsetUserData ( intptr_t  in_index)

Removes the user data at the given index from this kit.

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [2/3]

MeshKit& HPS::MeshKit::UnsetUserData ( size_t  in_count,
intptr_t const  in_indices[] 
)

Removes the user data at the given indices from this kit.

Parameters
in_countThe size of the following array.
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [3/3]

MeshKit& HPS::MeshKit::UnsetUserData ( IntPtrTArray const &  in_indices)

Removes the user data at the given indices from this kit.

Parameters
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

◆ UnsetVertexColors() [1/2]

MeshKit& HPS::MeshKit::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]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ UnsetVertexColorsByList() [1/4]

MeshKit& HPS::MeshKit::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 MeshKit.
in_facesThe indices of the vertices on which to remove the visibilities.
Returns
A reference to this MeshKit.

◆ UnsetVertexColorsByList() [2/4]

MeshKit& HPS::MeshKit::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 MeshKit.
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 MeshKit.

◆ UnsetVertexColorsByList() [3/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ UnsetVertexColorsByList() [4/4]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ UnsetVertexColorsByRange() [1/2]

MeshKit& HPS::MeshKit::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 MeshKit at which to start removing colors.
in_countThe number of vertex colors to unset for this MeshKit.
Returns
A reference to this MeshKit.

◆ UnsetVertexColorsByRange() [2/2]

MeshKit& HPS::MeshKit::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 MeshKit at which to start removing colors.
in_countThe number of vertex colors to unset for this MeshKit.
in_apply_toThe mesh component for which to remove the colors.
Returns
A reference to this MeshKit.

◆ UnsetVertexEverything()

MeshKit& HPS::MeshKit::UnsetVertexEverything ( )

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

Returns
A reference to this MeshKit.

◆ UnsetVertexNormals()

MeshKit& HPS::MeshKit::UnsetVertexNormals ( )

Removes all vertex normals.

Returns
A reference to this MeshKit.

◆ UnsetVertexNormalsByList()

MeshKit& HPS::MeshKit::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 MeshKit.

◆ UnsetVertexNormalsByRange()

MeshKit& HPS::MeshKit::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 MeshKit at which to start removing normals.
in_countThe number of vertex normals to unset for this MeshKit.
Returns
A reference to this MeshKit.

◆ UnsetVertexParameters()

MeshKit& HPS::MeshKit::UnsetVertexParameters ( )

Removes all texture parameters.

Returns
A reference to this MeshKit.

◆ UnsetVertexParametersByList()

MeshKit& HPS::MeshKit::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 MeshKit.

◆ UnsetVertexParametersByRange()

MeshKit& HPS::MeshKit::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 MeshKit at which to start removing texture parameters.
in_countThe number of texture parameters to unset for this MeshKit.
Returns
A reference to this MeshKit.

◆ UnsetVertexVisibilities()

MeshKit& HPS::MeshKit::UnsetVertexVisibilities ( )

Removes all vertex visibilities.

Returns
A reference to this MeshKit.

◆ UnsetVertexVisibilitiesByList() [1/2]

MeshKit& HPS::MeshKit::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 MeshKit.
in_facesThe indices of the vertices on which to remove the visibilities.
Returns
A reference to this MeshKit.

◆ UnsetVertexVisibilitiesByList() [2/2]

MeshKit& HPS::MeshKit::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 MeshKit.

◆ UnsetVertexVisibilitiesByRange()

MeshKit& HPS::MeshKit::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 MeshKit at which to start removing visibilities.
in_countThe number of vertex visibilities to unset for this MeshKit.
Returns
A reference to this MeshKit.

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