MeshKit

class HPS::MeshKit : public HPS::Kit 

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

Public Functions

void Consume(MeshKit &in_kit)

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

Parameters: in_kit – The source MeshKit to consume.

virtual bool Empty() const

Indicates whether this MeshKit has any values set on it.

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

bool Equals(MeshKit const &in_kit) const

Check if the source MeshKit is equivalent to this MeshKit.

Parameters: in_kit – The source MeshKit to compare to this MeshKit.
Returns: true if the objects are equivalent, false otherwise.

size_t GetPointCount() const

Retrieves the number of points in this mesh.

Returns: The number of points in this mesh.

MeshKit(): The default constructor creates an empty MeshKit object.

MeshKit(MeshKit &&in_that)

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

Parameters: in_that – An rvalue reference to a MeshKit to take the impl from.

MeshKit(MeshKit const &in_kit)

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

Parameters: in_kit – The source MeshKit 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.

bool operator!=(MeshKit const &in_kit) const

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

Parameters: in_kit – The source MeshKit to compare to this MeshKit.
Returns: true if the objects are not equivalent, false otherwise.

MeshKit &operator=(MeshKit &&in_that)

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

Parameters: in_that – An rvalue reference to a MeshKit to take the impl from.
Returns: A reference to this MeshKit.

MeshKit &operator=(MeshKit const &in_kit)

Copies the source MeshKit into this MeshKit.

Parameters: in_kit – The source MeshKit to copy.
Returns: A reference to this MeshKit.

bool operator==(MeshKit const &in_kit) const

Check if the source MeshKit is equivalent to this MeshKit.

Parameters: in_kit – The source MeshKit to compare to this MeshKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(MeshKit const &in_kit)

Copies the source MeshKit into this MeshKit.

Parameters: in_kit – The source MeshKit to copy.

MeshKit &SetColumns(size_t in_columns)

Sets the number of columns for this MeshKit.

Parameters: in_columns – The number of columns for this MeshKit.
Returns: A reference to this MeshKit.

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

Sets edge material indices on a selection of arbitrary edges.

Parameters

in_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 MeshKit.

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

Sets edge material indices on a selection of arbitrary edges.

Parameters

in_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 MeshKit.

MeshKit &SetEdgeIndexColorsByList(SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, float in_index)

Sets edge material indices on a selection of arbitrary edges.

Parameters

in_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 MeshKit.

MeshKit &SetEdgeIndexColorsByList(SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, FloatArray const &in_indices)

Sets edge material indices on a selection of arbitrary edges.

Parameters

in_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 MeshKit.

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

Sets edge colors on a selection of arbitrary edges.

Parameters

in_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 MeshKit.

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

Sets edge colors on a selection of arbitrary edges.

Parameters

in_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 MeshKit.

MeshKit &SetEdgeRGBColorsByList(SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, RGBColor const &in_rgb_color)

Sets edge colors on a selection of arbitrary edges.

Parameters

in_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 MeshKit.

MeshKit &SetEdgeRGBColorsByList(SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, RGBColorArray const &in_rgb_colors)

Sets edge colors on a selection of arbitrary edges.

Parameters

in_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 MeshKit.

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

Sets edge visibilities on a selection of arbitrary edges.

Parameters

in_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 MeshKit.

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

Sets edge visibilities on a selection of arbitrary edges.

Parameters

in_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 MeshKit.

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

MeshKit &SetEdgeVisibilitiesByList(SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, BoolArray const &in_visibilities)

Sets edge visibilities on a selection of arbitrary edges.

Parameters

in_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 MeshKit.

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

Sets face material indices on a selection of arbitrary faces.

Parameters

in_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 MeshKit.

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

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

Parameters

in_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 MeshKit.

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

MeshKit &SetFaceIndexColorsByList(SizeTArray const &in_faces, FloatArray const &in_indices)

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

Parameters

in_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 MeshKit.

MeshKit &SetFaceIndexColorsByRange(size_t in_start, FloatArray const &in_indices)

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

Parameters

in_start – The offset into the faces for this MeshKit at which to start setting colors.
in_indices – The material indices to set on the faces for this MeshKit.

Returns

A reference to this MeshKit.

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

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

Parameters

in_start – The offset into the faces for this MeshKit at which to start setting colors.
in_count – Size of the following array.
in_indices – The material indices to set on the faces for this MeshKit.

Returns

A reference to this MeshKit.

MeshKit &SetFaceIndexColorsByRange(size_t in_start, size_t in_count, float in_index)

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

Parameters

in_start – The offset into the faces for this MeshKit at which to start setting the color.
in_count – The number of faces on which to set the color.
in_index – The material index to set on the faces for this MeshKit.

Returns

A reference to this MeshKit.

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

Sets a single normal on a selection of arbitrary faces.

Parameters

in_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 MeshKit.

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

Sets face normals on a selection of arbitrary faces.

Parameters

in_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 MeshKit.

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

MeshKit &SetFaceNormalsByList(SizeTArray const &in_faces, VectorArray const &in_normals)

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

Parameters

in_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 MeshKit.

MeshKit &SetFaceNormalsByRange(size_t in_start, size_t in_count, Vector const &in_normal)

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

Parameters

in_start – The offset into the faces for this MeshKit at which to start setting the normal.
in_count – The number of faces on which to set the normal.
in_normal – The normal to set on the faces for this MeshKit.

Returns

A reference to this MeshKit.

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

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

Parameters

in_start – The offset into the faces for this MeshKit at which to start setting normals.
in_count – Size of the following array.
in_normals – The normals to set on the faces for this MeshKit.

Returns

A reference to this MeshKit.

MeshKit &SetFaceNormalsByRange(size_t in_start, VectorArray const &in_normals)

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

Parameters

in_start – The offset into the faces for this MeshKit at which to start setting normals.
in_normals – The normals to set on the faces for this MeshKit.

Returns

A reference to this MeshKit.

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

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

Parameters

in_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 MeshKit.

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

Sets face RGB colors on a selection of arbitrary faces.

Parameters

in_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 MeshKit.

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

MeshKit &SetFaceRGBColorsByList(SizeTArray const &in_faces, RGBColorArray const &in_rgb_colors)

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

Parameters

in_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 MeshKit.

MeshKit &SetFaceRGBColorsByRange(size_t in_start, RGBColorArray const &in_rgb_colors)

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

Parameters

in_start – The offset into the faces for this MeshKit at which to start setting colors.
in_rgb_colors – The RGB colors to set on the faces for this MeshKit.

Returns

A reference to this MeshKit.

MeshKit &SetFaceRGBColorsByRange(size_t in_start, size_t in_count, RGBColor const &in_rgb_color)

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

Parameters

in_start – The offset into the faces for this MeshKit at which to start setting the color.
in_count – The number of faces on which to set the color.
in_rgb_color – The RGB color to set on the faces for this MeshKit.

Returns

A reference to this MeshKit.

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

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

Parameters

in_start – The offset into the faces for this MeshKit at which to start setting colors.
in_count – Size of the following array.
in_rgb_colors – The RGB colors to set on the faces for this MeshKit.

Returns

A reference to this MeshKit.

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

Sets face visibilities on a selection of arbitrary faces.

Parameters

in_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 MeshKit.

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

Sets a single visibility on a selection of arbitrary faces.

Parameters

in_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 MeshKit.

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

MeshKit &SetFaceVisibilitiesByList(SizeTArray const &in_faces, BoolArray const &in_visibilities)

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

Parameters

in_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 MeshKit.

MeshKit &SetFaceVisibilitiesByRange(size_t in_start, BoolArray const &in_visibilities)

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

Parameters

in_start – The offset into the faces for this MeshKit at which to start setting visibilities.
in_visibilities – The visibilities to set on the faces for this MeshKit.

Returns

A reference to this MeshKit.

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

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

Parameters

in_start – The offset into the faces for this MeshKit at which to start setting visibilities.
in_count – Size of the following array.
in_visibilities – The visibilities to set on the faces for this MeshKit.

Returns

A reference to this MeshKit.

MeshKit &SetFaceVisibilitiesByRange(size_t in_start, size_t in_count, bool in_visibility)

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

Parameters

in_start – The offset into the faces for this MeshKit at which to start setting the visibility.
in_count – The number of faces on which to set the visibility.
in_visibility – The visibility to set on the faces for this MeshKit.

Returns

A reference to this MeshKit.

MeshKit &SetMaterialMapping(MaterialMappingKit const &in_kit)

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

Parameters: in_kit – The material mappings to set on this MeshKey.
Returns: A reference to this MeshKey.

MeshKit &SetPoints(PointArray const &in_points)

Sets the points for this MeshKit.

Parameters: in_points – The points for this MeshKit.
Returns: A reference to this MeshKit.

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

Sets the points for this MeshKit.

Parameters

in_count – Size of the following array.
in_points – The points for this MeshKit.

Returns

A reference to this MeshKit.

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

Sets the points, rows and columns for this MeshKit.

Parameters

in_rows – The number of rows for this MeshKit.
in_columns – The number of columns for this MeshKit.
in_points – The points to use to replace those on this MeshKit.

Returns

A reference to this MeshKit.

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

Sets the points, rows and columns for this MeshKit.

Parameters

in_rows – The number of rows for this MeshKit.
in_columns – The number of columns for this MeshKit.
in_count – Size of the following array.
in_points – The points to use to replace those on this MeshKit.

Returns

A reference to this MeshKit.

MeshKit &SetPriority(int in_priority)

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

See: SubwindowKit::SetPriority()
See: SubwindowKit::SetRenderingAlgorithm()

Parameters: in_priority – The drawing priority, higher priority items are drawn on top of lower priority items.
Returns: A reference to this object.

MeshKit &SetRows(size_t in_rows)

Sets the number of rows for this MeshKit.

Parameters: in_rows – The number of rows for this MeshKit.
Returns: A reference to this MeshKit.

MeshKit &SetUserData(intptr_t in_index, ByteArray const &in_data)

Sets user data on this kit.

Parameters

in_index – The index of the user data to set.
in_data – The bytes of user data to set.

Returns

A reference to this kit.

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

Sets user data on this kit.

Parameters

in_index – The index of the user data to set.
in_bytes – The number of bytes of user data to set.
in_data – The bytes of user data to set.

Returns

A reference to this kit.

MeshKit &SetUserData(IntPtrTArray const &in_indices, ByteArrayArray const &in_data)

Sets user data on this kit.

Parameters

in_indices – An array of user data indices to set.
in_data – An array of bytes of user data to set.

Returns

A reference to this kit.

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

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

Parameters

in_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 MeshKit.

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

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

Parameters

in_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 MeshKit.

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

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

Parameters

in_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 MeshKit.

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

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

Parameters

in_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 MeshKit.

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

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting colors.
in_indices – The material indices to set on the vertices for this MeshKit.
in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKit.

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

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting colors.
in_count – Size of the following array.
in_indices – The material indices to set on the vertices for this MeshKit.
in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKit.

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

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting the color.
in_count – The number of vertices on which to set the color.
in_index – The material index to set on the vertices for this MeshKit.
in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKit.

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

Sets a single normal on a selection of arbitrary vertices.

Parameters

in_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 MeshKit.

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

Sets vertex normals on a selection of arbitrary vertices.

Parameters

in_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 MeshKit.

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

MeshKit &SetVertexNormalsByList(SizeTArray const &in_vertices, VectorArray const &in_normals)

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

Parameters

in_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 MeshKit.

MeshKit &SetVertexNormalsByRange(size_t in_start, size_t in_count, Vector const &in_normal)

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting the normal.
in_count – The number of vertices on which to set the normal.
in_normal – The normal to set on the vertices for this MeshKit.

Returns

A reference to this MeshKit.

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

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting normals.
in_count – Size of the following array.
in_normals – The normals to set on the vertices for this MeshKit.

Returns

A reference to this MeshKit.

MeshKit &SetVertexNormalsByRange(size_t in_start, VectorArray const &in_normals)

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting normals.
in_normals – The normals to set on the vertices for this MeshKit.

Returns

A reference to this MeshKit.

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

Sets texture parameters on a selection of arbitrary vertices. If the sizes of the vertex index array and the texture 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 MeshKit.
in_param_width – The number of texture parameters per vertex. Defaults to 2.

Returns

A reference to this MeshKit.

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

Sets texture parameters on a selection of arbitrary vertices. If the sizes of the vertex index array and the texture 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 MeshKit. 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 MeshKit.

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

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting texture parameters.
in_params – The texture parameters to set on the vertices for this MeshKit. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored.
in_param_width – The number of texture parameters per vertex. Defaults to 2.

Returns

A reference to this MeshKit.

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

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting 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 MeshKit.
in_param_width – The number of texture parameters per vertex. Defaults to 2.

Returns

A reference to this MeshKit.

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

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

Parameters

in_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 MeshKit.

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

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

Parameters

in_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 MeshKit.

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

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

Parameters

in_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 MeshKit.

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

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

Parameters

in_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 MeshKit.

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

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

Parameters

in_start – The offset into the vertices for this MeshKey at which to start setting colors.
in_rgba_colors – The RGBA colors to set on the vertices for this MeshKit.
in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKit.

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

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting the color.
in_count – The number of vertices on which to set the color.
in_rgba_color – The RGBA color to set on the vertices for this MeshKit.
in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKit.

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

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting colors.
in_count – Size of the following array.
in_rgba_colors – The RGBA colors to set on the vertices for this MeshKit.
in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKit.

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

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

Parameters

in_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 MeshKit.

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

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

Parameters

in_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 MeshKit.

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

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

Parameters

in_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 MeshKit.

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

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

Parameters

in_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 MeshKit.

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

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting colors.
in_rgb_colors – The RGB colors to set on the vertices for this MeshKit.
in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKit.

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

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting the color.
in_count – The number of vertices on which to set the color.
in_rgb_color – The RGB color to set on the vertices for this MeshKit.
in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKit.

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

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

Parameters

in_start – The offset into the vertices for this MeshKey at which to start setting colors.
in_count – Size of the following array.
in_rgb_colors – The RGB colors to set on the vertices for this MeshKit.
in_apply_to – The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKit.

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

Sets vertex visibilities on a selection of arbitrary vertices.

Parameters

in_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 MeshKit.

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

Sets a single visibility on a selection of arbitrary vertices.

Parameters

in_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 MeshKit.

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

MeshKit &SetVertexVisibilitiesByList(SizeTArray const &in_vertices, BoolArray const &in_visibilities)

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

Parameters

in_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 MeshKit.

MeshKit &SetVertexVisibilitiesByRange(size_t in_start, BoolArray const &in_visibilities)

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting visibilities.
in_visibilities – The visibilities to set on the vertices for this MeshKit.

Returns

A reference to this MeshKit.

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

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting visibilities.
in_count – Size of the following array.
in_visibilities – The visibilities to set on the vertices for this MeshKit.

Returns

A reference to this MeshKit.

MeshKit &SetVertexVisibilitiesByRange(size_t in_start, size_t in_count, bool in_visibility)

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start setting the visibility.
in_count – The number of vertices on which to set the visibility.
in_visibility – The visibility to set on the vertices for this MeshKit.

Returns

A reference to this MeshKit.

void Show(MeshKit &out_kit) const

Copies this MeshKit into the given MeshKit.

Parameters: out_kit – The MeshKit to populate with the contents of this MeshKit.

bool ShowColumns(size_t &out_columns) const

Shows the number of columns for this MeshKit.

Parameters: out_columns – The number of columns for this MeshKit.
Returns: true if a number of columns was 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 MeshKit.

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 MeshKit.

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 all the face colors on this MeshKit.

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 MeshKit at which to start showing colors.
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 the all face normals on this MeshKit.

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

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 for each face. out_visibilities[i] is only valid if out_validities[i] is true.

Returns

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

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 MeshKit at which to start showing visibilities.
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 MeshKit. These are the “global” material settings, not the per-vertex and per-face material settings.

Parameters: out_kit – The material mappings set on this MeshKit.
Returns: true if material mappings were set, false otherwise.

bool ShowPoints(PointArray &out_points) const

Shows the points for this MeshKit.

Parameters: out_points – The points for this MeshKit.
Returns: true if points were set, false otherwise.

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

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

Parameters

out_rows – The number of rows for this MeshKit.
out_columns – The number of columns for this MeshKit.
out_points – The points for this MeshKit.

Returns

true if a number of rows, a number of columns, and 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 MeshKit 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 MeshKit.

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 MeshKit by list.

Parameters

in_indices – The list of point indices to show.
out_points – The requested points for this MeshKit.

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 MeshKit 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 MeshKit.

Returns

true if all requested points were set, false otherwise.

bool ShowPriority(int &out_priority) const

Shows the drawing priority.

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

bool ShowRows(size_t &out_rows) const

Shows the number of rows for this MeshKit.

Parameters: out_rows – The number of rows for this MeshKit.
Returns: true if a number of rows was set, false otherwise.

bool ShowUserData(intptr_t in_index, ByteArray &out_data) const

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

Parameters

in_index – The index of the user data to show.
out_data – The user data at the given index.

Returns

true if there is user data at the given index, false otherwise.

bool ShowUserData(IntPtrTArray &out_indices, ByteArrayArray &out_data) const

Shows all user data for this kit.

Parameters

out_indices – An array of all user data indices set on this kit.
out_data – An array of all user data set on this kit.

Returns

true if there is user data on this kit, false otherwise.

size_t ShowUserDataCount() const: Get the number of user data indices set on this kit.

bool ShowUserDataIndices(IntPtrTArray &out_indices) const

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

Parameters: out_indices – The user data indices set on this kit.
Returns: The number of user data indices set on this kit.

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

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 MeshKit at which to start showing normals.
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 of the vertices starting in this MeshKit. For this particular show function, the parameter width is returned implicitly and could be determined by out_params.size()/in_count.

Parameters

out_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 of the vertices starting in this MeshKit.

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 MeshKit at which to start showing texture parameters.
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 MeshKit at which to start showing texture parameters.
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 MeshKit.

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

MeshKit &UnsetAllUserData()

Removes all user data from this kit.

Returns: A reference to this kit.

MeshKit &UnsetColumns()

Removes the number of columns for this MeshKit.

Returns: A reference to this MeshKit.

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

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

Unsets edge colors on a selection of arbitrary edges.

Parameters

in_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 MeshKit.

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

MeshKit &UnsetEdgeEverything()

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

Returns: A reference to this MeshKit.

MeshKit &UnsetEdgeVisibilities()

Removes all edge visibilities.

Returns: A reference to this MeshKit.

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

Unsets edge visibilities on a selection of arbitrary edges.

Parameters

in_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 MeshKit.

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

MeshKit &UnsetEverything()

Removes all settings from this MeshKit.

Returns: A reference to this MeshKit.

MeshKit &UnsetFaceColors()

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

Returns: A reference to this MeshKit.

MeshKit &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 MeshKit.
in_faces – The indices of the faces on which to remove the visibilities.

Returns

A reference to this MeshKit.

MeshKit &UnsetFaceColorsByList(SizeTArray const &in_vertices)

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

Parameters: in_vertices – The indices of the faces on which to remove the colors.
Returns: A reference to this MeshKit.

MeshKit &UnsetFaceColorsByRange(size_t in_start, size_t in_count)

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

Parameters

in_start – The offset into the faces for this MeshKit at which to start removing colors.
in_count – The number of face colors to unset for this MeshKit.

Returns

A reference to this MeshKit.

MeshKit &UnsetFaceEverything()

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

Returns: A reference to this MeshKit.

MeshKit &UnsetFaceNormals()

Removes all face normals.

Returns: A reference to this MeshKit.

MeshKit &UnsetFaceNormalsByList(SizeTArray const &in_vertices)

Removes the face normals on a selection of arbitrary faces.

Parameters: in_vertices – The indices of the faces on which to remove the normals.
Returns: A reference to this MeshKit.

MeshKit &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 MeshKit at which to start removing normals.
in_count – The number of face normals to unset for this MeshKit.

Returns

A reference to this MeshKit.

MeshKit &UnsetFaceVisibilities()

Removes all face visibilities.

Returns: A reference to this MeshKit.

MeshKit &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 MeshKit.
in_faces – The indices of the faces on which to remove the visibilities.

Returns

A reference to this MeshKit.

MeshKit &UnsetFaceVisibilitiesByList(SizeTArray const &in_vertices)

Removes the face visibilities on a selection of arbitrary faces.

Parameters: in_vertices – The indices of the faces on which to remove the visibilities.
Returns: A reference to this MeshKit.

MeshKit &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 MeshKit at which to start removing visibilities.
in_count – The number of face visibilities to unset for this MeshKit.

Returns

A reference to this MeshKit.

MeshKit &UnsetMaterialMapping()

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

Returns: A reference to this MeshKit.

MeshKit &UnsetPoints()

Removes the points for this MeshKit.

Returns: A reference to this MeshKit.

MeshKit &UnsetPriority()

Removes a drawing priority setting.

Returns: A reference to this object.

MeshKit &UnsetRows()

Removes the number of rows for this MeshKit.

Returns: A reference to this MeshKit.

MeshKit &UnsetUserData(intptr_t in_index)

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

Parameters: in_index – The index of the user data to remove.
Returns: A reference to this kit.

MeshKit &UnsetUserData(IntPtrTArray const &in_indices)

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

Parameters: in_indices – The indices of the user data to remove.
Returns: A reference to this kit.

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

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

Parameters

in_count – The size of the following array.
in_indices – The indices of the user data to remove.

Returns

A reference to this kit.

MeshKit &UnsetVertexColors()

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

Returns: A reference to this MeshKey.

MeshKit &UnsetVertexColors(Mesh::Component in_apply_to)

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

Parameters: in_apply_to – The mesh component for which to remove the colors.
Returns: A reference to this MeshKit.

MeshKit &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 MeshKit.
in_faces – The indices of the vertices on which to remove the visibilities.

Returns

A reference to this MeshKit.

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

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters

in_count – The number of vertex visibilities to remove for this MeshKit.
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 MeshKit.

MeshKit &UnsetVertexColorsByList(SizeTArray const &in_vertices)

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

Parameters: in_vertices – The indices of the vertices on which to remove the colors.
Returns: A reference to this MeshKit.

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

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

Parameters

in_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 MeshKit.

MeshKit &UnsetVertexColorsByRange(size_t in_start, size_t in_count)

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start removing colors.
in_count – The number of vertex colors to unset for this MeshKit.

Returns

A reference to this MeshKit.

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

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

Parameters

in_start – The offset into the vertices for this MeshKit at which to start removing colors.
in_count – The number of vertex colors to unset for this MeshKit.
in_apply_to – The mesh component for which to remove the colors.

Returns

A reference to this MeshKit.

MeshKit &UnsetVertexEverything()

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

Returns: A reference to this MeshKit.

MeshKit &UnsetVertexNormals()

Removes all vertex normals.

Returns: A reference to this MeshKit.

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

MeshKit &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 MeshKit at which to start removing normals.
in_count – The number of vertex normals to unset for this MeshKit.

Returns

A reference to this MeshKit.

MeshKit &UnsetVertexParameters()

Removes all texture parameters.

Returns: A reference to this MeshKit.

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

MeshKit &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 MeshKit at which to start removing texture parameters.
in_count – The number of texture parameters to unset for this MeshKit.

Returns

A reference to this MeshKit.

MeshKit &UnsetVertexVisibilities()

Removes all vertex visibilities.

Returns: A reference to this MeshKit.

MeshKit &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 MeshKit.
in_faces – The indices of the vertices on which to remove the visibilities.

Returns

A reference to this MeshKit.

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

MeshKit &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 MeshKit at which to start removing visibilities.
in_count – The number of vertex visibilities to unset for this MeshKit.

Returns

A reference to this MeshKit.

virtual ~MeshKit()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::MeshKit