MeshKey

class HPS::MeshKey : public HPS::GeometryKey

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

Public Functions

void Consume(MeshKit &in_kit)

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

Parameters

in_kit – The kit from which to get the settings to replace on this MeshKey.

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

Replaces a range of points for this MeshKey.

Parameters
  • in_row_offset – The row offset into the MeshKey at which to start replacing points. This value must be such that in_row_offset<row_count for replacement to succeed.

  • in_column_offset – The column offset into the MeshKey at which to start replacing points. This value must be such that in_column_offset<column_count for replacement to succeed.

  • in_row_count – The number of rows to replace. This value must be such that in_row_offset+in_row_count<=row_count for replacement to succeed.

  • in_column_count – The number of columns to replace. This value must be such that in_column_offset+in_column_count<=column_count for replacement to succeed.

  • in_points – The points to use to replace those in the specified range. The size of the array should be in_row_count*in_column_count.

Returns

A reference to this MeshKey.

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

Replaces a range of points for this MeshKey.

Parameters
  • in_row_offset – The row offset into the MeshKey at which to start replacing points. This value must be such that in_row_offset<row_count for replacement to succeed.

  • in_column_offset – The column offset into the MeshKey at which to start replacing points. This value must be such that in_column_offset<column_count for replacement to succeed.

  • in_row_count – The number of rows to replace. This value must be such that in_row_offset+in_row_count<=row_count for replacement to succeed.

  • in_column_count – The number of columns to replace. This value must be such that in_column_offset+in_column_count<=column_count for replacement to succeed.

  • in_point_count – The size of the in_points array. The size of the array should be in_row_count*in_column_count.

  • in_points – The points to use to replace those in the specified range.

Returns

A reference to this MeshKey.

size_t GetPointCount() const

Retrieves the number of points in this mesh.

Returns

The number of points in this mesh.

MeshKey()

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

explicit MeshKey(Key const &in_that)

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

Parameters

in_that – The source Key to copy.

MeshKey(MeshKey &&in_that)

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

Parameters

in_that – An rvalue reference to a MeshKey to take the impl from.

MeshKey(MeshKey const &in_that)

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

Parameters

in_that – The source MeshKey to copy.

inline virtual HPS::Type ObjectType() const

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.

MeshKey &operator=(MeshKey &&in_that)

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

Parameters

in_that – An rvalue reference to a MeshKey to take the impl from.

Returns

A reference to this MeshKey.

MeshKey &operator=(MeshKey const &in_that)

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

Parameters

in_that – The source MeshKey for the assignment.

Returns

A reference to this MeshKey.

void Set(MeshKit const &in_kit)

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

Parameters

in_kit – The kit from which to get the settings to replace on this MeshKey.

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

Sets edge material indices on a selection of arbitrary edges.

Parameters
  • in_count – Size of the following arrays.

  • in_vertices1 – The 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_vertices2 – The 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_indices – The material indices to set on the edges.

Returns

A reference to this MeshKey.

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

Sets edge material indices on a selection of arbitrary edges.

Parameters
  • in_count – Size of the following arrays.

  • in_vertices1 – The 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_vertices2 – The 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_index – The material index to set on the edges.

Returns

A reference to this MeshKey.

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

Sets edge material indices on a selection of arbitrary edges.

Parameters
  • in_vertices1 – The 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_vertices2 – The 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_index – The material index to set on the edges.

Returns

A reference to this MeshKey.

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

Sets edge material indices on a selection of arbitrary edges.

Parameters
  • in_vertices1 – The 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_vertices2 – The 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_indices – The material indices to set on the edges.

Returns

A reference to this MeshKey.

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

Sets edge colors on a selection of arbitrary edges.

Parameters
  • in_count – Size of the following arrays.

  • in_vertices1 – The 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_vertices2 – The 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_color – The color to set on the edges.

Returns

A reference to this MeshKey.

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

Sets edge colors on a selection of arbitrary edges.

Parameters
  • in_count – Size of the following arrays.

  • in_vertices1 – The 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_vertices2 – The 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_colors – The colors to set on the edges.

Returns

A reference to this MeshKey.

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

Sets edge colors on a selection of arbitrary edges.

Parameters
  • in_vertices1 – The 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_vertices2 – The 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_color – The color to set on the edges.

Returns

A reference to this MeshKey.

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

Sets edge colors on a selection of arbitrary edges.

Parameters
  • in_vertices1 – The 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_vertices2 – The 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_colors – The colors to set on the edges.

Returns

A reference to this MeshKey.

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

Sets edge visibilities on a selection of arbitrary edges.

Parameters
  • in_count – Size of the following arrays.

  • in_vertices1 – The 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_vertices2 – The 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_visibilities – The visibilities that should be set for each edge specified.

Returns

A reference to this MeshKey.

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

Sets edge visibilities on a selection of arbitrary edges.

Parameters
  • in_count – Size of the following arrays.

  • in_vertices1 – The 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_vertices2 – The 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_visibility – The visibility to apply to each edge specified.

Returns

A reference to this MeshKey.

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

Sets edge visibilities on a selection of arbitrary edges.

Parameters
  • in_vertices1 – The 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_vertices2 – The 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_visibility – The visibility to apply to each edge specified.

Returns

A reference to this MeshKey.

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

Sets edge visibilities on a selection of arbitrary edges.

Parameters
  • in_vertices1 – The 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_vertices2 – The 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_visibilities – The visibilities that should be set for each edge specified.

Returns

A reference to this MeshKey.

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

Sets face material indices on a selection of arbitrary faces.

Parameters
  • in_count – Size of the following arrays.

  • in_faces – The indices of the faces on which to set the colors.

  • in_indices – The material indices to set on the faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_count – Size of the following array.

  • in_faces – The indices of the faces on which to set the color.

  • in_index – The material index to set on the faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_faces – The indices of the faces on which to set the color.

  • in_index – The material index to set on the faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_faces – The indices of the faces on which to set the colors.

  • in_indices – The material indices to set on the faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed.

  • in_indices – The material indices to set on the faces for this MeshKey. The size of the array must be such that in_start+in_indices.size()<=face_count for the setting to succeed.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed.

  • in_count – Size of the following array. This value must be such that in_start+in_count<=face_count for the setting to succeed.

  • in_indices – The material indices to set on the faces for this MeshKey.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start setting the color. This value must be such that in_start<face_count for setting to succeed.

  • in_count – The number of faces on which to set the color. This value must be such that in_start+in_count<=face_count for the setting to succeed.

  • in_index – The material index to set on the faces for this MeshKey.

Returns

A reference to this MeshKey.

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

Sets a single normal on a selection of arbitrary faces.

Parameters
  • in_count – Size of the following array.

  • in_faces – The indices of the faces on which to set the normal.

  • in_normal – The normal to set on the faces.

Returns

A reference to this MeshKey.

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

Sets face normals on a selection of arbitrary faces.

Parameters
  • in_count – Size of the following arrays.

  • in_faces – The indices of the faces on which to set the normals.

  • in_normals – The normals to set on the faces.

Returns

A reference to this MeshKey.

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

Sets a single normal on a selection of arbitrary faces.

Parameters
  • in_faces – The indices of the faces on which to set the normal.

  • in_normal – The normal to set on the faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_faces – The indices of the faces on which to set the normals.

  • in_normals – The normals to set on the faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start setting the normal. This value must be such that in_start<face_count for setting to succeed.

  • in_count – The number of faces on which to set the normal. This value must be such that in_start+in_count<=face_count for the setting to succeed.

  • in_normal – The normal to set on the faces for this MeshKey.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start setting normals. This value must be such that in_start<face_count for setting to succeed.

  • in_count – Size of the following array. This value must be such that in_start+in_count<=face_count for the setting to succeed.

  • in_normals – The normals to set on the faces for this MeshKey.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start setting normals. This value must be such that in_start<face_count for setting to succeed.

  • in_normals – The normals to set on the faces for this MeshKey. The size of the array must be such that in_start+in_normals.size()<=face_count for the setting to succeed.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_count – Size of the following array.

  • in_faces – The indices of the faces on which to set the color.

  • in_rgb_color – The RGB color to set on the faces.

Returns

A reference to this MeshKey.

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

Sets face RGB colors on a selection of arbitrary faces.

Parameters
  • in_count – Size of the following arrays.

  • in_faces – The indices of the faces on which to set the colors.

  • in_rgb_colors – The RGB colors to set on the faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_faces – The indices of the faces on which to set the color.

  • in_rgb_color – The RGB color to set on the faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_faces – The indices of the faces on which to set the colors.

  • in_rgb_colors – The RGB colors to set on the faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed.

  • in_rgb_colors – The RGB colors to set on the faces for this MeshKey. The size of the array must be such that in_start+in_rgb_colors.size()<=face_count for the setting to succeed.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start setting the color. This value must be such that in_start<face_count for setting to succeed.

  • in_count – The number of faces on which to set the color. This value must be such that in_start+in_count<=face_count for the setting to succeed.

  • in_rgb_color – The RGB color to set on the faces for this MeshKey.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed.

  • in_count – Size of the following array. This value must be such that in_start+in_count<=face_count for the setting to succeed.

  • in_rgb_colors – The RGB colors to set on the faces for this MeshKey.

Returns

A reference to this MeshKey.

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

Sets face visibilities on a selection of arbitrary faces.

Parameters
  • in_count – Size of the following arrays.

  • in_faces – The indices of the faces on which to set the visibilities.

  • in_visibilities – The visibilities to set on the faces.

Returns

A reference to this MeshKey.

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

Sets a single visibility on a selection of arbitrary faces.

Parameters
  • in_count – Size of the following array.

  • in_faces – The indices of the faces on which to set the visibility.

  • in_visibility – The visibility to set on the faces.

Returns

A reference to this MeshKey.

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

Sets a single visibility on a selection of arbitrary faces.

Parameters
  • in_faces – The indices of the faces on which to set the visibility.

  • in_visibility – The visibility to set on the faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_faces – The indices of the faces on which to set the visibilities.

  • in_visibilities – The visibilities to set on the faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start setting visibilities. This value must be such that in_start<face_count for setting to succeed.

  • in_visibilities – The visibilities to set on the faces for this MeshKey. The size of the array must be such that in_start+in_visibilities.size()<=face_count for the setting to succeed.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start setting visibilities. This value must be such that in_start<face_count for setting to succeed.

  • in_count – Size of the following array. This value must be such that in_start+in_count<=face_count for the setting to succeed.

  • in_visibilities – The visibilities to set on the faces for this MeshKey.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start setting the visibility. This value must be such that in_start<face_count for setting to succeed.

  • in_count – The number of faces on which to set the visibility. This value must be such that in_start+in_count<=face_count for the setting to succeed.

  • in_visibility – The visibility to set on the faces for this MeshKey.

Returns

A reference to this MeshKey.

MeshKey &SetMaterialMapping(MaterialMappingKit const &in_kit)

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

Parameters

in_kit – The material mappings to set on this MeshKey.

Returns

A reference to this MeshKey.

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

Replace the points on this MeshKey with the specified points.

Parameters
  • in_rows – The number of rows for this MeshKey.

  • in_columns – The number of columns for this MeshKey.

  • in_points – The points to use to replace those on this MeshKey.

Returns

A reference to this MeshKey.

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

Replace the points on this MeshKey with the specified points.

Parameters
  • in_rows – The number of rows for this MeshKey.

  • in_columns – The number of columns for this MeshKey.

  • in_count – Size of the following array.

  • in_points – The points to use to replace those on this MeshKey.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_count – Size of the following arrays.

  • in_vertices – The indices of the vertices on which to set the colors.

  • in_indices – The material indices to set on the vertices.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_count – Size of the following array.

  • in_vertices – The indices of the vertices on which to set the color.

  • in_index – The material index to set on the vertices.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_vertices – The indices of the vertices on which to set the color.

  • in_index – The material index to set on the vertices.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_vertices – The indices of the vertices on which to set the colors.

  • in_indices – The material indices to set on the vertices.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.

  • in_indices – The material indices to set on the vertices for this MeshKey. The size of the array must be such that in_start+in_indices.size()<=vertex_count for the setting to succeed.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.

  • in_count – Size of the following array. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.

  • in_indices – The material indices to set on the vertices for this MeshKey.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.

  • in_count – The number of vertices on which to set the color. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.

  • in_index – The material index to set on the vertices for this MeshKey.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

Sets a single normal on a selection of arbitrary vertices.

Parameters
  • in_count – Size of the following array.

  • in_vertices – The indices of the vertices on which to set the normal.

  • in_normal – The normal to set on the vertices.

Returns

A reference to this MeshKey.

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

Sets vertex normals on a selection of arbitrary vertices.

Parameters
  • in_count – Size of the following arrays.

  • in_vertices – The indices of the vertices on which to set the normals.

  • in_normals – The normals to set on the vertices.

Returns

A reference to this MeshKey.

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

Sets a single normal on a selection of arbitrary vertices.

Parameters
  • in_vertices – The indices of the vertices on which to set the normal.

  • in_normal – The normal to set on the vertices.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_vertices – The indices of the vertices on which to set the normals.

  • in_normals – The normals to set on the vertices.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting the normal. This value must be such that in_start<point_count for setting to succeed.

  • in_count – The number of vertices on which to set the normal. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.

  • in_normal – The normal to set on the vertices for this MeshKey.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting normals. This value must be such that in_start<point_count for setting to succeed.

  • in_count – Size of the following array. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.

  • in_normals – The normals to set on the vertices for this MeshKey.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting normals. This value must be such that in_start<point_count for setting to succeed.

  • in_normals – The normals to set on the vertices for this MeshKey. The size of the array must be such that in_start+in_normals.size()<=vertex_count for the setting to succeed.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_vertex_count – Size of the following array.

  • in_vertices – The indices of the vertices on which to set the texture parameters.

  • in_param_count – Size of the following array. This should be divisible by the parameter width, if it is not, some parameters will get ignored.

  • in_params – The texture parameters to set on the vertices for this MeshKey.

  • in_param_width – The number of texture parameters per vertex. Defaults to 2.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_vertices – The indices of the vertices on which to set the texture parameters.

  • in_params – The texture parameters to set on the vertices for this MeshKey. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored.

  • in_param_width – The number of texture parameters per vertex. Defaults to 2.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting texture parameters. This value must be such that in_start<point_count for setting to succeed.

  • in_params – The texture parameters to set on the vertices for this MeshKey. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored. This value must be such that in_start+in_params.size()/in_param_width<=point_count for the setting to succeed.

  • in_param_width – The number of texture parameters per vertex. Defaults to 2.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting texture parameters. This value must be such that in_start<point_count for setting to succeed.

  • in_param_count – Size of the following array. This should be divisible by the parameter width, if it is not, some parameters will get ignored. This value must be such that in_start+in_param_count/in_param_width<=point_count for the setting to succeed.

  • in_params – The texture parameters to set on the vertices for this MeshKey.

  • in_param_width – The number of texture parameters per vertex. Defaults to 2.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_count – Size of the following array.

  • in_vertices – The indices of the vertices on which to set the color.

  • in_rgba_color – The RGBA color to set on the vertices.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_count – Size of the following arrays.

  • in_vertices – The indices of the vertices on which to set the colors.

  • in_rgba_colors – The RGBA colors to set on the vertices.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_vertices – The indices of the vertices on which to set the color.

  • in_rgba_color – The RGBA color to set on the vertices.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_vertices – The indices of the vertices on which to set the colors.

  • in_rgba_colors – The RGBA colors to set on the vertices.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.

  • in_rgba_colors – The RGBA colors to set on the vertices for this MeshKey. The size of the array must be such that in_start+in_rgba_colors.size()<=vertex_count for the setting to succeed.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.

  • in_count – The number of vertices on which to set the color. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.

  • in_rgba_color – The RGBA color to set on the vertices for this MeshKey.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.

  • in_count – Size of the following array. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.

  • in_rgba_colors – The RGBA colors to set on the vertices for this MeshKey.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_count – Size of the following array.

  • in_vertices – The indices of the vertices on which to set the color.

  • in_rgb_color – The RGB color to set on the vertices.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_count – Size of the following arrays.

  • in_vertices – The indices of the vertices on which to set the colors.

  • in_rgb_colors – The RGB colors to set on the vertices.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_vertices – The indices of the vertices on which to set the color.

  • in_rgb_color – The RGB color to set on the vertices.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_vertices – The indices of the vertices on which to set the colors.

  • in_rgb_colors – The RGB colors to set on the vertices.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.

  • in_rgb_colors – The RGB colors to set on the vertices for this MeshKey. The size of the array must be such that in_start+in_rgb_colors.size()<=vertex_count for the setting to succeed.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.

  • in_count – The number of vertices on which to set the color. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.

  • in_rgb_color – The RGB color to set on the vertices for this MeshKey.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.

  • in_count – Size of the following array. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.

  • in_rgb_colors – The RGB colors to set on the vertices for this MeshKey.

  • in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

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

Sets vertex visibilities on a selection of arbitrary vertices.

Parameters
  • in_count – Size of the following arrays.

  • in_vertices – The indices of the vertices on which to set the visibilities.

  • in_visibilities – The visibilities to set on the vertices.

Returns

A reference to this MeshKey.

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

Sets a single visibility on a selection of arbitrary vertices.

Parameters
  • in_count – Size of the following array.

  • in_vertices – The indices of the vertices on which to set the visibility.

  • in_visibility – The visibility to set on the vertices.

Returns

A reference to this MeshKey.

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

Sets a single visibility on a selection of arbitrary vertices.

Parameters
  • in_vertices – The indices of the vertices on which to set the visibility.

  • in_visibility – The visibility to set on the vertices.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_vertices – The indices of the vertices on which to set the visibilities.

  • in_visibilities – The visibilities to set on the vertices.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting visibilities. This value must be such that in_start<point_count for setting to succeed.

  • in_visibilities – The visibilities to set on the vertices for this MeshKey. The size of the array must be such that in_start+in_visibilities.size()<=vertex_count for the setting to succeed.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting visibilities. This value must be such that in_start<point_count for setting to succeed.

  • in_count – Size of the following array. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.

  • in_visibilities – The visibilities to set on the vertices for this MeshKey.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start setting the visibility. This value must be such that in_start<point_count for setting to succeed.

  • in_count – The number of vertices on which to set the visibility. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.

  • in_visibility – The visibility to set on the vertices for this MeshKey.

Returns

A reference to this MeshKey.

void Show(MeshKit &out_kit) const

Copy the contents of this MeshKey into the specified kit.

Parameters

out_kit – The kit to populate with the contents of this MeshKey.

bool ShowColumns(size_t &out_columns) const

Show the number of columns for this MeshKey.

Parameters

out_columns – The number of columns for this MeshKey.

Returns

true if columns were set, false otherwise.

bool 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_vertices1 – The vertex indices that correspond to the start position of each edge for which the visibilities are being changed.

  • out_vertices2 – The vertex indices that correspond to the end position of each edge for which the visibilities are being changed.

  • out_types – The types of edge colors for each edge.

  • out_rgb_colors – The 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_indices – The colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is MaterialIndex.

Returns

A reference to this MeshKey.

bool 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_vertices1 – The 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_vertices2 – The 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_types – The types of edge colors for each edge.

  • out_rgb_colors – The 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_indices – The colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is Material::Type::MaterialIndex.

Returns

A reference to this MeshKey.

bool 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_vertices1 – The 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_vertices2 – The 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_validities – The 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_visibilities – The 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.

bool ShowFaceColors(MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const

Shows the face colors on MeshKey.

Parameters
  • out_types – The 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_colors – The RGB colors for each face. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.

  • out_indices – The 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.

bool 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_faces – The indices of the faces on which to show the colors.

  • out_types – The 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_colors – The 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_indices – The 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.

bool 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_start – The offset into the faces for this MeshKey at which to start showing colors. This value must be such that in_start<face_count for showing to succeed.

  • in_count – The number of colors to show.

  • out_types – The 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_colors – The 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_indices – The 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.

bool ShowFaceNormals(BoolArray &out_validities, VectorArray &out_normals) const

Shows all the face normals for this MeshKey.

Parameters
  • out_validities – The 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_normals – The 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.

bool 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_faces – The indices of the faces on which to show the normals.

  • out_validities – The 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_normals – The 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.

bool 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_start – The offset into the faces for this MeshKey at which to start showing normals. This value must be such that in_start<face_count for showing to succeed.

  • in_count – The number of normals to show.

  • out_validities – The 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_normals – The 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.

bool ShowFaceVisibilities(BoolArray &out_validities, BoolArray &out_visibilities) const

Shows all the face visibilities on this MeshKey.

Parameters
  • out_validities – The 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_visibilities – The face visibilities or each face. out_visibilities[i] is only valid if out_validities[i] is true.

Returns

true if any face had a face visibility set, false otherwise.

bool 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_faces – The indices of the faces on which to show the normals.

  • out_validities – The 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_visibilities – The 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.

bool 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_start – The offset into the faces for this MeshKey at which to start showing visibilities. This value must be such that in_start<face_count for showing to succeed.

  • in_count – The number of visibilities to show.

  • out_validities – The 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_visibilities – The 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.

bool ShowMaterialMapping(MaterialMappingKit &out_kit) const

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

Parameters

out_kit – The material mappings set on this MeshKey.

Returns

true if material mappings were set, false otherwise.

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

Shows the all net vertex normals on this MeshKey.

Parameters
  • out_normals – The vertex normals for each vertex.

  • in_polygon_handedness – The polygon handedness to assume when returning normals. Defaults to None. Specifying no handedness when requesting net normals, will return the normals using the handedness used internally by Visualize for this particular shell. When specifying a handedness, only normals which were implicitly calculated by Visualize will be flipped to conform to the requested handedness. User specified normals will be left untouched.

Returns

true if no errors were encountered, false otherwise.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start showing normals. This value must be such that in_start<point_count for showing to succeed.

  • in_count – The number of normals to show. This value must be such that in_start+in_count<=point_count for the showing to succeed.

  • out_normals – The vertex normals for each vertex in the specified range.

  • in_polygon_handedness – The polygon handedness to assume when returning normals. Defaults to None. Specifying no handedness when requesting net normals, will return the normals using the handedness used internally by Visualize for this particular shell. When specifying a handedness, only normals which were implicitly calculated by Visualize will be flipped to conform to the requested handedness. User specified normals will be left untouched.

Returns

true if no errors were encountered, false otherwise.

bool ShowPoints(PointArray &out_points) const

Show the points for this MeshKey.

Parameters

out_points – The points for this MeshKey.

Returns

true if points were set, false otherwise.

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

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

Parameters
  • out_rows – The number of rows for this MeshKey.

  • out_columns – The number of columns for this MeshKey.

  • out_points – The points for this MeshKey.

Returns

true if points were set, false otherwise.

bool ShowPointsByList(size_t in_count, size_t const in_indices[], PointArray &out_points) const

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

Parameters
  • in_count – The number of points to show.

  • in_indices – The list of point indices to show.

  • out_points – The requested points for this MeshKey.

Returns

true if all requested points were set, false otherwise.

bool ShowPointsByList(SizeTArray const &in_indices, PointArray &out_points) const

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

Parameters
  • in_indices – The list of point indices to show.

  • out_points – The requested points for this MeshKey.

Returns

true if all requested points were set, false otherwise.

bool ShowPointsByRange(size_t in_start_index, size_t in_count, PointArray &out_points) const

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

Parameters
  • in_start_index – The first point to show.

  • in_count – The number of points to show.

  • out_points – The requested points for this MeshKey.

Returns

true if all requested points were set, false otherwise.

bool ShowRows(size_t &out_rows) const

Show the number of rows for this MeshKey.

Parameters

out_rows – The number of rows for this MeshKey.

Returns

true if rows were set, false otherwise.

bool 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_to – The mesh component the colors should apply to.

  • out_types – The 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_colors – The RGB colors for each vertex. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.

  • out_rgba_colors – The RGBA colors for each vertex. out_rgba_colors[i] is only valid if out_types[i] is Material::Type::RGBAColor.

  • out_indices – The 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.

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

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_vertices – The indices of the vertices on which to show the colors.

  • in_apply_to – The mesh component the colors should apply to.

  • out_types – The 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_colors – The 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_colors – The 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_indices – The 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.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start showing colors. This value must be such that in_start<point_count for removal to succeed.

  • in_count – The number of colors to show.

  • in_apply_to – The mesh component the colors should apply to.

  • out_types – The 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_colors – The 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_colors – The 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_indices – The 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.

bool ShowVertexNormals(BoolArray &out_validities, VectorArray &out_normals) const

Shows all the vertex normals on this MeshKey.

Parameters
  • out_validities – The 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_normals – The 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.

bool 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_vertices – The indices of the vertices on which to show the normals.

  • out_validities – The 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_normals – The 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.

bool 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_start – The offset into the vertices for this MeshKey at which to start showing normals. This value must be such that in_start<point_count for showing to succeed.

  • in_count – The number of normals to show.

  • out_validities – The 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_normals – The 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.

bool ShowVertexParameters(BoolArray &out_validities, FloatArray &out_params) const

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

Parameters
  • out_validities – The 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_params – The 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.

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

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

Parameters
  • out_validities – The 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_params – The 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_width – The number of texture parameters per vertex.

Returns

true if any vertex had a texture parameter set, false otherwise.

bool 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_vertices – The indices of the vertices on which to show the texture parameters.

  • out_validities – The 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_params – The 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.

bool 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_vertices – The indices of the vertices on which to show the texture parameters.

  • out_validities – The 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_params – The 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_width – The number of texture parameters per vertex.

Returns

true if any specified vertex had a texture parameter set, false otherwise.

bool 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_start – The offset into the vertices for this MeshKey at which to start showing texture parameters. This value must be such that in_start<point_count for showing to succeed.

  • in_count – The number of vertices for which to show the texture parameters.

  • out_validities – The 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_params – The 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.

bool 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_start – The offset into the vertices for this MeshKey at which to start showing texture parameters. This value must be such that in_start<point_count for showing to succeed.

  • in_count – The number of vertices for which to show the texture parameters.

  • out_validities – The 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_params – The 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_width – The number of texture parameters per vertex.

Returns

true if any vertex in the specified range had a texture parameter set, false otherwise.

bool ShowVertexVisibilities(BoolArray &out_validities, BoolArray &out_visibilities) const

Shows all the vertex visibilities on this MeshKey.

Parameters
  • out_validities – The 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_visibilities – The 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.

bool 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_vertices – The indices of the vertices on which to show the normals.

  • out_validities – The 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_visibilities – The 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.

bool 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_start – The offset into the vertices for this MeshKey at which to start showing visibilities. This value must be such that in_start<point_count for showing to succeed.

  • in_count – The number of visibilities to show.

  • out_validities – The 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_visibilities – The 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.

MeshKey &UnsetEdgeColors()

Unsets edge colors on all edges.

Parameters
  • in_vertices1 – The 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_vertices2 – The 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_types – The types of edge colors for each edge.

  • out_rgb_colors – The 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_indices – The colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is Material::Type::MaterialIndex.

Returns

A reference to this MeshKey.

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

Unsets edge colors on a selection of arbitrary edges.

Parameters
  • in_count – Size of the following arrays.

  • in_vertices1 – The 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_vertices2 – The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.

Returns

A reference to this MeshKey.

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

Unsets edge colors on a selection of arbitrary edges.

Parameters
  • in_vertices1 – The 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_vertices2 – The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.

Returns

A reference to this MeshKey.

MeshKey &UnsetEdgeEverything()

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

Returns

A reference to this MeshKey.

MeshKey &UnsetEdgeVisibilities()

Removes all edge visibilities.

Returns

A reference to this MeshKey.

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

Unsets edge visibilities on a selection of arbitrary edges.

Parameters
  • in_count – Size of the following arrays.

  • in_vertices1 – The 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_vertices2 – The vertex indices that correspond to the end position of each edge for which the visibilities are being unset. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.

Returns

A reference to this MeshKey.

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

Unsets edge visibilities on a selection of arbitrary edges.

Parameters
  • in_vertices1 – The 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_vertices2 – The vertex indices that correspond to the end position of each edge for which the visibilities are being unset. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.

Returns

A reference to this MeshKey.

MeshKey &UnsetEverything()

Removes all settings from this MeshKey.

Returns

A reference to this MeshKey.

MeshKey &UnsetFaceColors()

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

Returns

A reference to this MeshKey.

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

Removes the face visibilities on a selection of arbitrary faces.

Parameters
  • in_count – The number of face visibilities to remove for this MeshKey.

  • in_faces – The indices of the faces on which to remove the visibilities.

Returns

A reference to this MeshKey.

MeshKey &UnsetFaceColorsByList(SizeTArray const &in_faces)

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

Parameters

in_faces – The indices of the faces on which to remove the colors.

Returns

A reference to this MeshKey.

MeshKey &UnsetFaceColorsByRange(size_t in_start, size_t in_count)

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start removing colors. This value must be such that in_start<face_count for removal to succeed.

  • in_count – The number of face colors to unset for this MeshKey.

Returns

A reference to this MeshKey.

MeshKey &UnsetFaceEverything()

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

Returns

A reference to this MeshKey.

MeshKey &UnsetFaceNormals()

Removes all face normals.

Returns

A reference to this MeshKey.

MeshKey &UnsetFaceNormalsByList(SizeTArray const &in_faces)

Removes the face normals on a selection of arbitrary faces.

Parameters

in_faces – The indices of the faces on which to remove the normals.

Returns

A reference to this MeshKey.

MeshKey &UnsetFaceNormalsByRange(size_t in_start, size_t in_count)

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start removing normals. This value must be such that in_start<face_count for removal to succeed.

  • in_count – The number of face normals to unset for this MeshKey.

Returns

A reference to this MeshKey.

MeshKey &UnsetFaceVisibilities()

Removes all face visibilities.

Returns

A reference to this MeshKey.

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

Removes the face visibilities on a selection of arbitrary faces.

Parameters
  • in_count – The number of face visibilities to remove for this MeshKey.

  • in_faces – The indices of the faces on which to remove the visibilities.

Returns

A reference to this MeshKey.

MeshKey &UnsetFaceVisibilitiesByList(SizeTArray const &in_faces)

Removes the face visibilities on a selection of arbitrary faces.

Parameters

in_faces – The indices of the faces on which to remove the visibilities.

Returns

A reference to this MeshKey.

MeshKey &UnsetFaceVisibilitiesByRange(size_t in_start, size_t in_count)

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

Parameters
  • in_start – The offset into the faces for this MeshKey at which to start removing visibilities. This value must be such that in_start<face_count for removal to succeed.

  • in_count – The number of face visibilities to unset for this MeshKey.

Returns

A reference to this MeshKey.

MeshKey &UnsetMaterialMapping()

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

Returns

A reference to this MeshKey.

MeshKey &UnsetVertexColors()

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

Returns

A reference to this MeshKey.

MeshKey &UnsetVertexColors(Mesh::Component in_apply_to)

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

Parameters

in_apply_to – The mesh component for which to remove the colors.

Returns

A reference to this MeshKey.

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

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters
  • in_count – The number of vertex visibilities to remove for this MeshKey.

  • in_faces – The indices of the vertices on which to remove the visibilities.

Returns

A reference to this MeshKey.

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

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters
  • in_count – The number of vertex visibilities to remove for this MeshKey.

  • in_faces – The indices of the vertices on which to remove the visibilities.

  • in_apply_to – The shell component the colors should apply to.

Returns

A reference to this MeshKey.

MeshKey &UnsetVertexColorsByList(SizeTArray const &in_vertices)

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

Parameters

in_vertices – The indices of the vertices on which to remove the colors.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_vertices – The indices of the vertices on which to remove the colors.

  • in_apply_to – The mesh component for which to remove the colors.

Returns

A reference to this MeshKey.

MeshKey &UnsetVertexColorsByRange(size_t in_start, size_t in_count)

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start removing colors. This value must be such that in_start<point_count for removal to succeed.

  • in_count – The number of vertex colors to unset for this MeshKey.

Returns

A reference to this MeshKey.

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

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start removing colors. This value must be such that in_start<point_count for removal to succeed.

  • in_count – The number of vertex colors to unset for this MeshKey.

  • in_apply_to – The mesh component for which to remove the colors.

Returns

A reference to this MeshKey.

MeshKey &UnsetVertexEverything()

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

Returns

A reference to this MeshKey.

MeshKey &UnsetVertexNormals()

Removes all vertex normals.

Returns

A reference to this MeshKey.

MeshKey &UnsetVertexNormalsByList(SizeTArray const &in_vertices)

Removes the vertex normals on a selection of arbitrary vertices.

Parameters

in_vertices – The indices of the vertices on which to remove the normals.

Returns

A reference to this MeshKey.

MeshKey &UnsetVertexNormalsByRange(size_t in_start, size_t in_count)

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start removing normals. This value must be such that in_start<point_count for removal to succeed.

  • in_count – The number of vertex normals to unset for this MeshKey.

Returns

A reference to this MeshKey.

MeshKey &UnsetVertexParameters()

Removes all texture parameters.

Returns

A reference to this MeshKey.

MeshKey &UnsetVertexParametersByList(SizeTArray const &in_vertices)

Removes the texture parameters on a selection of arbitrary vertices.

Parameters

in_vertices – The indices of the vertices on which to remove the texture parameters.

Returns

A reference to this MeshKey.

MeshKey &UnsetVertexParametersByRange(size_t in_start, size_t in_count)

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start removing texture parameters. This value must be such that in_start<point_count for removal to succeed.

  • in_count – The number of texture parameters to unset for this MeshKey.

Returns

A reference to this MeshKey.

MeshKey &UnsetVertexVisibilities()

Removes all vertex visibilities.

Returns

A reference to this MeshKey.

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

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters
  • in_count – The number of vertex visibilities to remove for this MeshKey.

  • in_faces – The indices of the vertices on which to remove the visibilities.

Returns

A reference to this MeshKey.

MeshKey &UnsetVertexVisibilitiesByList(SizeTArray const &in_vertices)

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters

in_vertices – The indices of the vertices on which to remove the visibilities.

Returns

A reference to this MeshKey.

MeshKey &UnsetVertexVisibilitiesByRange(size_t in_start, size_t in_count)

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

Parameters
  • in_start – The offset into the vertices for this MeshKey at which to start removing visibilities. This value must be such that in_start<point_count for removal to succeed.

  • in_count – The number of vertex visibilities to unset for this MeshKey.

Returns

A reference to this MeshKey.

~MeshKey()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::MeshKey