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 (HPS.MeshKit in_kit)

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

Param in_kit

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

override void Dispose ()
HPS.MeshKey EditMeshByReplacement (ulong in_row_offset, ulong in_column_offset, ulong in_row_count, ulong in_column_count, HPS.Point[] in_points)

Replaces a range of points for this MeshKey.

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

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

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

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

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

Return

A reference to this MeshKey.

ulong GetPointCount ()

Retrieves the number of points in this mesh.

Return

The number of points in this mesh.

MeshKey ()

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

MeshKey (HPS.Key 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.

Param in_that

The source Key to copy.

MeshKey (HPS.MeshKey in_that)

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

Param in_that

The source MeshKey to copy.

override HPS.Type ObjectType ()

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

Return

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

void Set (HPS.MeshKit in_kit)

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

Param in_kit

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

HPS.MeshKey SetEdgeIndexColorsByList (ulong[] in_vertices1, ulong[] in_vertices2, float in_index)

Sets edge material indices on a selection of arbitrary edges.

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

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

Param in_index

The material index to set on the edges.

Return

A reference to this MeshKey.

HPS.MeshKey SetEdgeIndexColorsByList (ulong[] in_vertices1, ulong[] in_vertices2, float[] in_indices)

Sets edge material indices on a selection of arbitrary edges.

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

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

Param in_indices

The material indices to set on the edges.

Return

A reference to this MeshKey.

HPS.MeshKey SetEdgeRGBColorsByList (ulong[] in_vertices1, ulong[] in_vertices2, HPS.RGBColor in_rgb_color)

Sets edge colors on a selection of arbitrary edges.

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

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

Param in_rgb_color

The color to set on the edges.

Return

A reference to this MeshKey.

HPS.MeshKey SetEdgeRGBColorsByList (ulong[] in_vertices1, ulong[] in_vertices2, HPS.RGBColor[] in_rgb_colors)

Sets edge colors on a selection of arbitrary edges.

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

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

Param in_rgb_colors

The colors to set on the edges.

Return

A reference to this MeshKey.

HPS.MeshKey SetEdgeVisibilitiesByList (ulong[] in_vertices1, ulong[] in_vertices2, bool in_visibility)

Sets edge visibilities on a selection of arbitrary edges.

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

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

Param in_visibility

The visibility to apply to each edge specified.

Return

A reference to this MeshKey.

HPS.MeshKey SetEdgeVisibilitiesByList (ulong[] in_vertices1, ulong[] in_vertices2, bool[] in_visibilities)

Sets edge visibilities on a selection of arbitrary edges.

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

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

Param in_visibilities

The visibilities that should be set for each edge specified.

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceIndexColorsByList (ulong[] in_faces, float in_index)

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

Param in_faces

The indices of the faces on which to set the color.

Param in_index

The material index to set on the faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceIndexColorsByList (ulong[] in_faces, float[] 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.

Param in_faces

The indices of the faces on which to set the colors.

Param in_indices

The material indices to set on the faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceIndexColorsByRange (ulong in_start, float[] in_indices)

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

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

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

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceIndexColorsByRange (ulong in_start, ulong in_count, float in_index)

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

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

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

Param in_index

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

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceNormalsByList (ulong[] in_faces, HPS.Vector in_normal)

Sets a single normal on a selection of arbitrary faces.

Param in_faces

The indices of the faces on which to set the normal.

Param in_normal

The normal to set on the faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceNormalsByList (ulong[] in_faces, HPS.Vector[] 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.

Param in_faces

The indices of the faces on which to set the normals.

Param in_normals

The normals to set on the faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceNormalsByRange (ulong in_start, HPS.Vector[] in_normals)

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

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

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

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceNormalsByRange (ulong in_start, ulong in_count, HPS.Vector in_normal)

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

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

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

Param in_normal

The normal to set on the faces for this MeshKey.

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceRGBColorsByList (ulong[] in_faces, HPS.RGBColor in_rgb_color)

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

Param in_faces

The indices of the faces on which to set the color.

Param in_rgb_color

The RGB color to set on the faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceRGBColorsByList (ulong[] in_faces, HPS.RGBColor[] 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.

Param in_faces

The indices of the faces on which to set the colors.

Param in_rgb_colors

The RGB colors to set on the faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors)

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

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

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

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color)

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

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

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

Param in_rgb_color

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

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceVisibilitiesByList (ulong[] in_faces, bool in_visibility)

Sets a single visibility on a selection of arbitrary faces.

Param in_faces

The indices of the faces on which to set the visibility.

Param in_visibility

The visibility to set on the faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceVisibilitiesByList (ulong[] in_faces, bool[] 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.

Param in_faces

The indices of the faces on which to set the visibilities.

Param in_visibilities

The visibilities to set on the faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceVisibilitiesByRange (ulong in_start, bool[] in_visibilities)

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

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

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

Return

A reference to this MeshKey.

HPS.MeshKey SetFaceVisibilitiesByRange (ulong in_start, ulong in_count, bool in_visibility)

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

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

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

Param in_visibility

The visibility to set on the faces for this MeshKey.

Return

A reference to this MeshKey.

HPS.MeshKey SetMaterialMapping (HPS.MaterialMappingKit 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.

Param in_kit

The material mappings to set on this MeshKey.

Return

A reference to this MeshKey.

HPS.MeshKey SetPoints (ulong in_rows, ulong in_columns, HPS.Point[] in_points)

Replace the points on this MeshKey with the specified points.

Param in_rows

The number of rows for this MeshKey.

Param in_columns

The number of columns for this MeshKey.

Param in_points

The points to use to replace those on this MeshKey.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexIndexColorsByList (ulong[] in_vertices, float in_index)

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

Param in_vertices

The indices of the vertices on which to set the color.

Param in_index

The material index to set on the vertices.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexIndexColorsByList (ulong[] in_vertices, float in_index, HPS.Mesh.Component in_apply_to)

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

Param in_vertices

The indices of the vertices on which to set the color.

Param in_index

The material index to set on the vertices.

Param in_apply_to

The mesh component the colors should apply to. Defaults to Mesh.Component.Faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices)

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.

Param in_vertices

The indices of the vertices on which to set the colors.

Param in_indices

The material indices to set on the vertices.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices, HPS.Mesh.Component in_apply_to)

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.

Param in_vertices

The indices of the vertices on which to set the colors.

Param in_indices

The material indices to set on the vertices.

Param in_apply_to

The mesh component the colors should apply to. Defaults to Mesh.Component.Faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexIndexColorsByRange (ulong in_start, float[] in_indices)

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

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

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

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexIndexColorsByRange (ulong in_start, float[] in_indices, HPS.Mesh.Component in_apply_to)

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

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

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

Param in_apply_to

The mesh component the colors should apply to. Defaults to Mesh.Component.Faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index)

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

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

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

Param in_index

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

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index, HPS.Mesh.Component in_apply_to)

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

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

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

Param in_index

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

Param in_apply_to

The mesh component the colors should apply to. Defaults to Mesh.Component.Faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexNormalsByList (ulong[] in_vertices, HPS.Vector in_normal)

Sets a single normal on a selection of arbitrary vertices.

Param in_vertices

The indices of the vertices on which to set the normal.

Param in_normal

The normal to set on the vertices.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexNormalsByList (ulong[] in_vertices, HPS.Vector[] 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.

Param in_vertices

The indices of the vertices on which to set the normals.

Param in_normals

The normals to set on the vertices.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexNormalsByRange (ulong in_start, HPS.Vector[] in_normals)

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

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

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

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexNormalsByRange (ulong in_start, ulong in_count, HPS.Vector in_normal)

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

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

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

Param in_normal

The normal to set on the vertices for this MeshKey.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexParametersByList (ulong[] in_vertices, float[] in_params)

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.

Param in_vertices

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

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

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexParametersByList (ulong[] in_vertices, float[] in_params, ulong in_param_width)

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.

Param in_vertices

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

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

Param in_param_width

The number of texture parameters per vertex. Defaults to 2.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexParametersByRange (ulong in_start, float[] in_params)

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

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

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

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexParametersByRange (ulong in_start, float[] in_params, ulong in_param_width)

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

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

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

Param in_param_width

The number of texture parameters per vertex. Defaults to 2.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor in_rgba_color)

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

Param in_vertices

The indices of the vertices on which to set the color.

Param in_rgba_color

The RGBA color to set on the vertices.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor in_rgba_color, HPS.Mesh.Component in_apply_to)

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

Param in_vertices

The indices of the vertices on which to set the color.

Param in_rgba_color

The RGBA color to set on the vertices.

Param in_apply_to

The mesh component the colors should apply to. Defaults to Mesh.Component.Faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor[] in_rgba_colors)

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.

Param in_vertices

The indices of the vertices on which to set the colors.

Param in_rgba_colors

The RGBA colors to set on the vertices.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor[] in_rgba_colors, HPS.Mesh.Component in_apply_to)

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.

Param in_vertices

The indices of the vertices on which to set the colors.

Param in_rgba_colors

The RGBA colors to set on the vertices.

Param in_apply_to

The mesh component the colors should apply to. Defaults to Mesh.Component.Faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBAColorsByRange (ulong in_start, HPS.RGBAColor[] in_rgba_colors)

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

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

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

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBAColorsByRange (ulong in_start, HPS.RGBAColor[] in_rgba_colors, HPS.Mesh.Component in_apply_to)

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

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

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

Param in_apply_to

The mesh component the colors should apply to. Defaults to Mesh.Component.Faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBAColorsByRange (ulong in_start, ulong in_count, HPS.RGBAColor in_rgba_color)

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

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

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

Param in_rgba_color

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

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBAColorsByRange (ulong in_start, ulong in_count, HPS.RGBAColor in_rgba_color, HPS.Mesh.Component in_apply_to)

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

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

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

Param in_rgba_color

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

Param in_apply_to

The mesh component the colors should apply to. Defaults to Mesh.Component.Faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color)

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

Param in_vertices

The indices of the vertices on which to set the color.

Param in_rgb_color

The RGB color to set on the vertices.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color, HPS.Mesh.Component in_apply_to)

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

Param in_vertices

The indices of the vertices on which to set the color.

Param in_rgb_color

The RGB color to set on the vertices.

Param in_apply_to

The mesh component the colors should apply to. Defaults to Mesh.Component.Faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors)

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.

Param in_vertices

The indices of the vertices on which to set the colors.

Param in_rgb_colors

The RGB colors to set on the vertices.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors, HPS.Mesh.Component in_apply_to)

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.

Param in_vertices

The indices of the vertices on which to set the colors.

Param in_rgb_colors

The RGB colors to set on the vertices.

Param in_apply_to

The mesh component the colors should apply to. Defaults to Mesh.Component.Faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors)

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

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

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

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors, HPS.Mesh.Component in_apply_to)

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

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

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

Param in_apply_to

The mesh component the colors should apply to. Defaults to Mesh.Component.Faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color)

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

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

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

Param in_rgb_color

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

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color, HPS.Mesh.Component in_apply_to)

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

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

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

Param in_rgb_color

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

Param in_apply_to

The mesh component the colors should apply to. Defaults to Mesh.Component.Faces.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexVisibilitiesByList (ulong[] in_vertices, bool in_visibility)

Sets a single visibility on a selection of arbitrary vertices.

Param in_vertices

The indices of the vertices on which to set the visibility.

Param in_visibility

The visibility to set on the vertices.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexVisibilitiesByList (ulong[] in_vertices, bool[] 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.

Param in_vertices

The indices of the vertices on which to set the visibilities.

Param in_visibilities

The visibilities to set on the vertices.

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexVisibilitiesByRange (ulong in_start, bool[] in_visibilities)

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

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

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

Return

A reference to this MeshKey.

HPS.MeshKey SetVertexVisibilitiesByRange (ulong in_start, ulong in_count, bool in_visibility)

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

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

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

Param in_visibility

The visibility to set on the vertices for this MeshKey.

Return

A reference to this MeshKey.

void Show (out HPS.MeshKit out_kit)

Copy the contents of this MeshKey into the specified kit.

Param out_kit

The kit to populate with the contents of this MeshKey.

bool ShowColumns (out ulong out_columns)

Show the number of columns for this MeshKey.

Param out_columns

The number of columns for this MeshKey.

Return

true if columns were set, false otherwise.

bool ShowEdgeColors (out ulong[] out_vertices1, out ulong[] out_vertices2, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)

Sets edge colors on a selection of arbitrary edges.

Param out_vertices1

The vertex indices that correspond to the start position of each edge for which the visibilities are being changed.

Param out_vertices2

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

Param out_types

The types of edge colors for each edge.

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

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

Return

A reference to this MeshKey.

bool ShowEdgeColorsByList (ulong[] in_vertices1, ulong[] in_vertices2, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)

Sets edge colors on a selection of arbitrary edges.

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

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

Param out_types

The types of edge colors for each edge.

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

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

Return

A reference to this MeshKey.

bool ShowEdgeVisibilitiesByList (ulong[] in_vertices1, ulong[] in_vertices2, out bool[] out_validities, out bool[] out_visibilities)

Shows all the edge visibilities on this ShellKey.

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

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

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

Param out_visibilities

The edge visibilities for each edge. out_visibilities[i] is only valid if out_validities[i] is true.

Return

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

bool ShowFaceColors (out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)

Shows the face colors on MeshKey.

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

Param out_rgb_colors

The RGB colors for each face. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor.

Param out_indices

The material indices for each face. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.

Return

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

bool ShowFaceColorsByList (ulong[] in_faces, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)

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

Param in_faces

The indices of the faces on which to show the colors.

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

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

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

Return

true if any specified face had a face color set, false otherwise.

bool ShowFaceColorsByRange (ulong in_start, ulong in_count, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)

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

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

Param in_count

The number of colors to show.

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

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

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

Return

true if any face in the specified range had a face color set, false otherwise.

bool ShowFaceNormals (out bool[] out_validities, out HPS.Vector[] out_normals)

Shows all the face normals for this MeshKey.

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

Param out_normals

The face normals for each face. out_normals[i] is only valid if out_validities[i] is true.

Return

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

bool ShowFaceNormalsByList (ulong[] in_faces, out bool[] out_validities, out HPS.Vector[] out_normals)

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

Param in_faces

The indices of the faces on which to show the normals.

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

Param out_normals

The face normals for each face at the specified index. out_normals[i] is only valid if out_validities[i] is true.

Return

true if any specified face had a face normal set, false otherwise.

bool ShowFaceNormalsByRange (ulong in_start, ulong in_count, out bool[] out_validities, out HPS.Vector[] out_normals)

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

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

Param in_count

The number of normals to show.

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

Param out_normals

The face normals for each face in the specified range. out_normals[i] is only valid if out_validities[i] is true.

Return

true if any face in the specified range had a face normal set, false otherwise.

bool ShowFaceVisibilities (out bool[] out_validities, out bool[] out_visibilities)

Shows all the face visibilities on this MeshKey.

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

Param out_visibilities

The face visibilities or each face. out_visibilities[i] is only valid if out_validities[i] is true.

Return

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

bool ShowFaceVisibilitiesByList (ulong[] in_faces, out bool[] out_validities, out bool[] out_visibilities)

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

Param in_faces

The indices of the faces on which to show the normals.

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

Param out_visibilities

The face visibilities for each face at the specified index. out_visibilities[i] is only valid if out_validities[i] is true.

Return

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

bool ShowFaceVisibilitiesByRange (ulong in_start, ulong in_count, out bool[] out_validities, out bool[] out_visibilities)

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

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

Param in_count

The number of visibilities to show.

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

Param out_visibilities

The face visibilities for each face in the specified range. out_visibilities[i] is only valid if out_validities[i] is true.

Return

true if any face in the specified range had a face visibility set, false otherwise.

bool ShowMaterialMapping (out HPS.MaterialMappingKit out_kit)

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

Param out_kit

The material mappings set on this MeshKey.

Return

true if material mappings were set, false otherwise.

bool ShowNetVertexNormals (out HPS.Vector[] out_normals)

Shows the all net vertex normals on this MeshKey.

Param out_normals

The vertex normals for each vertex.

Return

true if no errors were encountered, false otherwise.

bool ShowNetVertexNormals (out HPS.Vector[] out_normals, HPS.Drawing.Handedness in_polygon_handedness)

Shows the all net vertex normals on this MeshKey.

Param out_normals

The vertex normals for each vertex.

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

Return

true if no errors were encountered, false otherwise.

bool ShowNetVertexNormalsByRange (ulong in_start, ulong in_count, out HPS.Vector[] out_normals)

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

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

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

Param out_normals

The vertex normals for each vertex in the specified range.

Return

true if no errors were encountered, false otherwise.

bool ShowNetVertexNormalsByRange (ulong in_start, ulong in_count, out HPS.Vector[] out_normals, HPS.Drawing.Handedness in_polygon_handedness)

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

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

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

Param out_normals

The vertex normals for each vertex in the specified range.

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

Return

true if no errors were encountered, false otherwise.

bool ShowPoints (out HPS.Point[] out_points)

Show the points for this MeshKey.

Param out_points

The points for this MeshKey.

Return

true if points were set, false otherwise.

bool ShowPoints (out ulong out_rows, out ulong out_columns, out HPS.Point[] out_points)

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

Param out_rows

The number of rows for this MeshKey.

Param out_columns

The number of columns for this MeshKey.

Param out_points

The points for this MeshKey.

Return

true if points were set, false otherwise.

bool ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points)

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

Param in_indices

The list of point indices to show.

Param out_points

The requested points for this MeshKey.

Return

true if all requested points were set, false otherwise.

bool ShowPointsByRange (ulong in_start_index, ulong in_count, out HPS.Point[] out_points)

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

Param in_start_index

The first point to show.

Param in_count

The number of points to show.

Param out_points

The requested points for this MeshKey.

Return

true if all requested points were set, false otherwise.

bool ShowRows (out ulong out_rows)

Show the number of rows for this MeshKey.

Param out_rows

The number of rows for this MeshKey.

Return

true if rows were set, false otherwise.

bool ShowVertexColors (HPS.Mesh.Component in_apply_to, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out HPS.RGBAColor[] out_rgba_colors, out float[] out_indices)

Shows all the vertex colors on the specified mesh component.

Param in_apply_to

The mesh component the colors should apply to.

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

Param out_rgb_colors

The RGB colors for each vertex. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor.

Param out_rgba_colors

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

Param out_indices

The material indices for each vertex. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.

Return

true if any vertex colors were shown, false otherwise.

bool ShowVertexColorsByList (ulong[] in_vertices, HPS.Mesh.Component in_apply_to, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out HPS.RGBAColor[] out_rgba_colors, out float[] out_indices)

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

Param in_vertices

The indices of the vertices on which to show the colors.

Param in_apply_to

The mesh component the colors should apply to.

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

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

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

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

Return

true if any specified vertex had a vertex color on the specified component set, false otherwise.

bool ShowVertexColorsByRange (ulong in_start, ulong in_count, HPS.Mesh.Component in_apply_to, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out HPS.RGBAColor[] out_rgba_colors, out float[] out_indices)

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

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

Param in_count

The number of colors to show.

Param in_apply_to

The mesh component the colors should apply to.

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

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

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

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

Return

true if any vertex in the specified range had a vertex color on the specified component set, false otherwise.

bool ShowVertexNormals (out bool[] out_validities, out HPS.Vector[] out_normals)

Shows all the vertex normals on this MeshKey.

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

Param out_normals

The vertex normals for each vertex. out_normals[i] is only valid if out_validities[i] is true.

Return

true if any vertex normals were shown, false otherwise.

bool ShowVertexNormalsByList (ulong[] in_vertices, out bool[] out_validities, out HPS.Vector[] out_normals)

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

Param in_vertices

The indices of the vertices on which to show the normals.

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

Param out_normals

The vertex normals for each vertex at the specified index. out_normals[i] is only valid if out_validities[i] is true.

Return

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

bool ShowVertexNormalsByRange (ulong in_start, ulong in_count, out bool[] out_validities, out HPS.Vector[] out_normals)

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

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

Param in_count

The number of normals to show.

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

Param out_normals

The vertex normals for each vertex in the specified range. out_normals[i] is only valid if out_validities[i] is true.

Return

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

bool ShowVertexParameters (out bool[] out_validities, out float[] out_params)

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.

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

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

Return

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

bool ShowVertexParameters (out bool[] out_validities, out float[] out_params, out ulong out_param_width)

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

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

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

Param out_param_width

The number of texture parameters per vertex.

Return

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

bool ShowVertexParametersByList (ulong[] in_vertices, out bool[] out_validities, out float[] out_params)

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

Param in_vertices

The indices of the vertices on which to show the texture parameters.

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

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

Return

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

bool ShowVertexParametersByList (ulong[] in_vertices, out bool[] out_validities, out float[] out_params, out ulong out_param_width)

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

Param in_vertices

The indices of the vertices on which to show the texture parameters.

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

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

Param out_param_width

The number of texture parameters per vertex.

Return

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

bool ShowVertexParametersByRange (ulong in_start, ulong in_count, out bool[] out_validities, out float[] out_params)

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.

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

Param in_count

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

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

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

Return

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

bool ShowVertexParametersByRange (ulong in_start, ulong in_count, out bool[] out_validities, out float[] out_params, out ulong out_param_width)

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

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

Param in_count

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

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

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

Param out_param_width

The number of texture parameters per vertex.

Return

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

bool ShowVertexVisibilities (out bool[] out_validities, out bool[] out_visibilities)

Shows all the vertex visibilities on this MeshKey.

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

Param out_visibilities

The vertex visibilities for each vertex. out_visibilities[i] is only valid if out_validities[i] is true.

Return

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

bool ShowVertexVisibilitiesByList (ulong[] in_vertices, out bool[] out_validities, out bool[] out_visibilities)

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

Param in_vertices

The indices of the vertices on which to show the normals.

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

Param out_visibilities

The vertex visibilities for each vertex at the specified index. out_visibilities[i] is only valid if out_validities[i] is true.

Return

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

bool ShowVertexVisibilitiesByRange (ulong in_start, ulong in_count, out bool[] out_validities, out bool[] out_visibilities)

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

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

Param in_count

The number of visibilities to show.

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

Param out_visibilities

The vertex visibilities for each vertex in the specified range. out_visibilities[i] is only valid if out_validities[i] is true.

Return

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

HPS.MeshKey UnsetEdgeColors ()

Unsets edge colors on all edges.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetEdgeColorsByList (ulong[] in_vertices1, ulong[] in_vertices2)

Unsets edge colors on a selection of arbitrary edges.

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

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetEdgeEverything ()

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetEdgeVisibilities ()

Removes all edge visibilities.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetEdgeVisibilitiesByList (ulong[] in_vertices1, ulong[] in_vertices2)

Unsets edge visibilities on a selection of arbitrary edges.

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

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetEverything ()

Removes all settings from this MeshKey.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetFaceColors ()

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetFaceColorsByList (ulong[] in_faces)

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

Param in_faces

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetFaceColorsByRange (ulong in_start, ulong in_count)

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

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

Param in_count

The number of face colors to unset for this MeshKey.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetFaceEverything ()

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetFaceNormals ()

Removes all face normals.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetFaceNormalsByList (ulong[] in_faces)

Removes the face normals on a selection of arbitrary faces.

Param in_faces

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetFaceNormalsByRange (ulong in_start, ulong in_count)

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

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

Param in_count

The number of face normals to unset for this MeshKey.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetFaceVisibilities ()

Removes all face visibilities.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetFaceVisibilitiesByList (ulong[] in_faces)

Removes the face visibilities on a selection of arbitrary faces.

Param in_faces

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetFaceVisibilitiesByRange (ulong in_start, ulong in_count)

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

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

Param in_count

The number of face visibilities to unset for this MeshKey.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetMaterialMapping ()

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexColors ()

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexColors (HPS.Mesh.Component in_apply_to)

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

Param in_apply_to

The mesh component for which to remove the colors.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexColorsByList (ulong[] in_vertices)

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

Param in_vertices

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexColorsByList (ulong[] in_vertices, HPS.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.

Param in_vertices

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

Param in_apply_to

The mesh component for which to remove the colors.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexColorsByRange (ulong in_start, ulong 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.

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

Param in_count

The number of vertex colors to unset for this MeshKey.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexColorsByRange (ulong in_start, ulong in_count, HPS.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.

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

Param in_count

The number of vertex colors to unset for this MeshKey.

Param in_apply_to

The mesh component for which to remove the colors.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexEverything ()

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexNormals ()

Removes all vertex normals.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexNormalsByList (ulong[] in_vertices)

Removes the vertex normals on a selection of arbitrary vertices.

Param in_vertices

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexNormalsByRange (ulong in_start, ulong in_count)

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

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

Param in_count

The number of vertex normals to unset for this MeshKey.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexParameters ()

Removes all texture parameters.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexParametersByList (ulong[] in_vertices)

Removes the texture parameters on a selection of arbitrary vertices.

Param in_vertices

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexParametersByRange (ulong in_start, ulong in_count)

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

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

Param in_count

The number of texture parameters to unset for this MeshKey.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexVisibilities ()

Removes all vertex visibilities.

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexVisibilitiesByList (ulong[] in_vertices)

Removes the vertex visibilities on a selection of arbitrary vertices.

Param in_vertices

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

Return

A reference to this MeshKey.

HPS.MeshKey UnsetVertexVisibilitiesByRange (ulong in_start, ulong in_count)

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

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

Param in_count

The number of vertex visibilities to unset for this MeshKey.

Return

A reference to this MeshKey.