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

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

Public Member 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. More...
 
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. More...
 
ulong GetPointCount ()
 Retrieves the number of points in this mesh. More...
 
 MeshKey ()
 The default constructor creates an uninitialized MeshKey object. The Type() function will return Type::None. More...
 
 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. More...
 
 MeshKey (HPS.MeshKey in_that)
 The copy constructor creates a MeshKey object that shares the underlying smart-pointer of the source MeshKey. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.MeshKit in_kit)
 Replace those settings on this MeshKey with those set on the specified kit. More...
 
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. More...
 
HPS.MeshKey SetFaceIndexColorsByList (ulong[] in_faces, float in_index)
 Sets a single material index on a selection of arbitrary faces. More...
 
HPS.MeshKey SetFaceIndexColorsByRange (ulong in_start, float[] in_indices)
 Sets face material indices on a range of faces starting at the specified offset. More...
 
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. More...
 
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. More...
 
HPS.MeshKey SetFaceNormalsByList (ulong[] in_faces, HPS.Vector in_normal)
 Sets a single normal on a selection of arbitrary faces. More...
 
HPS.MeshKey SetFaceNormalsByRange (ulong in_start, HPS.Vector[] in_normals)
 Sets face normals on a range of faces starting at the specified offset. More...
 
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. More...
 
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. More...
 
HPS.MeshKey SetFaceRGBColorsByList (ulong[] in_faces, HPS.RGBColor in_rgb_color)
 Sets a single RGB color on a selection of arbitrary faces. More...
 
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. More...
 
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. More...
 
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. More...
 
HPS.MeshKey SetFaceVisibilitiesByList (ulong[] in_faces, bool in_visibility)
 Sets a single visibility on a selection of arbitrary faces. More...
 
HPS.MeshKey SetFaceVisibilitiesByRange (ulong in_start, bool[] in_visibilities)
 Sets face visibilities on a range of faces starting at the specified offset. More...
 
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. More...
 
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. More...
 
HPS.MeshKey SetPoints (ulong in_rows, ulong in_columns, HPS.Point[] in_points)
 Replace the points on this MeshKey with the specified points. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
HPS.MeshKey SetVertexNormalsByList (ulong[] in_vertices, HPS.Vector in_normal)
 Sets a single normal on a selection of arbitrary vertices. More...
 
HPS.MeshKey SetVertexNormalsByRange (ulong in_start, HPS.Vector[] in_normals)
 Sets vertex normals on a range of vertices starting at the specified offset. More...
 
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. More...
 
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 paramter array (divided by the parameter width) are different, the smaller size will be used. More...
 
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 paramter array (divided by the parameter width) are different, the smaller size will be used. More...
 
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. More...
 
HPS.MeshKey SetVertexParametersByRange (ulong in_start, float[] in_params)
 Sets texture parameters on a range of vertices starting at the specified offset. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
HPS.MeshKey SetVertexVisibilitiesByList (ulong[] in_vertices, bool in_visibility)
 Sets a single visibility on a selection of arbitrary vertices. More...
 
HPS.MeshKey SetVertexVisibilitiesByRange (ulong in_start, bool[] in_visibilities)
 Sets vertex visibilities on a range of vertices starting at the specified offset. More...
 
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. More...
 
void Show (out HPS.MeshKit out_kit)
 Copy the contents of this MeshKey into the specified kit. More...
 
bool ShowColumns (out ulong out_columns)
 Show the number of columns for this MeshKey. More...
 
bool ShowFaceColors (out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)
 Shows the face colors on MeshKey. More...
 
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]. More...
 
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. More...
 
bool ShowFaceNormals (out bool[] out_validities, out HPS.Vector[] out_normals)
 Shows all the face normals for this MeshKey. More...
 
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]. More...
 
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. More...
 
bool ShowFaceVisibilities (out bool[] out_validities, out bool[] out_visibilities)
 Shows all the face visibilities on this MeshKey. More...
 
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]. More...
 
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. More...
 
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. More...
 
bool ShowPoints (out HPS.Point[] out_points)
 Show the points for this MeshKey. More...
 
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. More...
 
bool ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points)
 Show a subset of the points for this MeshKey by list. More...
 
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. More...
 
bool ShowRows (out ulong out_rows)
 Show the number of rows for this MeshKey. More...
 
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. More...
 
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]. More...
 
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. More...
 
bool ShowVertexNormals (out bool[] out_validities, out HPS.Vector[] out_normals)
 Shows all the vertex normals on this MeshKey. More...
 
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]. More...
 
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. More...
 
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. More...
 
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. More...
 
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]. More...
 
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]. More...
 
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. More...
 
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. More...
 
bool ShowVertexVisibilities (out bool[] out_validities, out bool[] out_visibilities)
 Shows all the vertex visibilities on this MeshKey. More...
 
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]. More...
 
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. More...
 
HPS.MeshKey UnsetEverything ()
 Removes all settings from this MeshKey. More...
 
HPS.MeshKey UnsetFaceColors ()
 Removes all face colors (RGB colors or material indices). More...
 
HPS.MeshKey UnsetFaceColorsByList (ulong[] in_faces)
 Removes the face colors (RGB colors or material indices) on a selection of arbitrary vertices. More...
 
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. More...
 
HPS.MeshKey UnsetFaceEverything ()
 Removes all face settings (face colors, face normals, and face visibilities) from this MeshKey. More...
 
HPS.MeshKey UnsetFaceNormals ()
 Removes all face normals. More...
 
HPS.MeshKey UnsetFaceNormalsByList (ulong[] in_faces)
 Removes the face normals on a selection of arbitrary faces. More...
 
HPS.MeshKey UnsetFaceNormalsByRange (ulong in_start, ulong in_count)
 Removes the specified range of face normals starting at the specified offset. More...
 
HPS.MeshKey UnsetFaceVisibilities ()
 Removes all face visibilities. More...
 
HPS.MeshKey UnsetFaceVisibilitiesByList (ulong[] in_faces)
 Removes the face visibilities on a selection of arbitrary faces. More...
 
HPS.MeshKey UnsetFaceVisibilitiesByRange (ulong in_start, ulong in_count)
 Removes the specified range of face visibilities starting at the specified offset. More...
 
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. More...
 
HPS.MeshKey UnsetVertexColors ()
 Removes all vertex colors (RGB colors, RGBA colors, or material indices) for all mesh components. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
HPS.MeshKey UnsetVertexEverything ()
 Removes all vertex settings (vertex colors, vertex normals, texture parameters, and vertex visibilities) from this MeshKey. More...
 
HPS.MeshKey UnsetVertexNormals ()
 Removes all vertex normals. More...
 
HPS.MeshKey UnsetVertexNormalsByList (ulong[] in_vertices)
 Removes the vertex normals on a selection of arbitrary vertices. More...
 
HPS.MeshKey UnsetVertexNormalsByRange (ulong in_start, ulong in_count)
 Removes the specified range of vertex normals starting at the specified offset. More...
 
HPS.MeshKey UnsetVertexParameters ()
 Removes all texture parameters. More...
 
HPS.MeshKey UnsetVertexParametersByList (ulong[] in_vertices)
 Removes the texture parameters on a selection of arbitrary vertices. More...
 
HPS.MeshKey UnsetVertexParametersByRange (ulong in_start, ulong in_count)
 Removes the specified range of texture parameters starting at the specified offset. More...
 
HPS.MeshKey UnsetVertexVisibilities ()
 Removes all vertex visibilities. More...
 
HPS.MeshKey UnsetVertexVisibilitiesByList (ulong[] in_vertices)
 Removes the vertex visibilities on a selection of arbitrary vertices. More...
 
HPS.MeshKey UnsetVertexVisibilitiesByRange (ulong in_start, ulong in_count)
 Removes the specified range of vertex visibilities starting at the specified offset. More...
 
- Public Member Functions inherited from HPS.GeometryKey
 GeometryKey ()
 The default constructor creates an uninitialized GeometryKey object. The Type() function will return Type::None. More...
 
 GeometryKey (HPS.Key in_that)
 This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really a type of geometry key. Otherwise the copy will fail and the resulting GeometryKey will be invalid. More...
 
 GeometryKey (HPS.GeometryKey in_that)
 The copy constructor creates a GeometryKey object that shares the underlying smart-pointer of the source GeometryKey. More...
 
HPS.GeometryKey SetPriority (int in_priority)
 Assigns a drawing priority value to the geometry. It affects the order in which the geometry is visited if and only if the rendering algorithm is set to Priority. The geometry has a default drawing priority assigned, based on the order of insertion. More...
 
HPS.GeometryKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 Sets user data on this key. More...
 
HPS.GeometryKey SetUserData (IntPtr in_index, byte[] in_data)
 Sets user data on this key. More...
 
HPS.GeometryKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 Sets user data on this key. More...
 
bool ShowBounding (out HPS.BoundingKit out_kit)
 Shows the bounding of this geometry. More...
 
bool ShowPriority (out int out_priority)
 Shows the drawing priority. More...
 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 Shows the all the segments which contain references to this key. Note that while a segment may only appear once in the returned array, that segment could have multiple references to this key. More...
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 Shows the all the references to this key. More...
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 Shows the user data at a given index for this key. More...
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 Shows all user data for this key. More...
 
ulong ShowUserDataCount ()
 Get the number of user data indices set on this key. More...
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 Shows the indices of all user data set on this key. More...
 
HPS.GeometryKey UnsetAllUserData ()
 Removes all user data from this key. More...
 
HPS.GeometryKey UnsetPriority ()
 Removes the drawing priority setting. More...
 
HPS.GeometryKey UnsetUserData (IntPtr in_index)
 Removes the user data at the given index from this key. More...
 
HPS.GeometryKey UnsetUserData (IntPtr[] in_indices)
 Removes the user data at the given indices from this key. More...
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 Share the underlying smart-pointer of the Key source. More...
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 Copies the database object referred to by this key into a segment pointed to by in_destination. More...
 
void Delete ()
 Removes the database object referred to by this key. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 Determines whether the database objects pointed to by this key and in_that are the same. Empty keys (when key.Empty() returns true) are never equal to any key, even when the key is compared against itself (they act analogously to NaN comparisons in this case.) More...
 
ulong GetHash ()
 Returns a hash code for the key. More...
 
override int GetHashCode ()
 
bool HasOwner ()
 
Returns
Indicates whether this key has an owner or not.

 
 Key ()
 An uninitialized key refers to no database object and Type() will return Type::None. More...
 
 Key (HPS.Key in_that)
 Shares a reference to a database object referred to by in_that. More...
 
 Key (HPS.Control in_control)
 Initializes a key tied to the Control in_control. More...
 
void MoveTo (HPS.SegmentKey in_new_owner)
 Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. More...
 
HPS.SegmentKey Owner ()
 
Returns
The segment containing this key.

 
HPS.SegmentKey Up ()
 
Returns
The segment containing this key.

 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator!= (HPS.Key a, HPS.Key b)
 
static bool operator== (HPS.Key a, HPS.Key b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

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

Constructor & Destructor Documentation

HPS.MeshKey.MeshKey ( )
inline

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

HPS.MeshKey.MeshKey ( HPS.Key  in_that)
inline

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

Parameters
in_thatThe source Key to copy.
HPS.MeshKey.MeshKey ( HPS.MeshKey  in_that)
inline

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

Parameters
in_thatThe source MeshKey to copy.

Member Function Documentation

void HPS.MeshKey.Consume ( HPS.MeshKit  in_kit)
inline

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

Parameters
in_kitThe kit from which to get the settings to replace on this MeshKey.
HPS.MeshKey HPS.MeshKey.EditMeshByReplacement ( ulong  in_row_offset,
ulong  in_column_offset,
ulong  in_row_count,
ulong  in_column_count,
HPS.Point[]  in_points 
)
inline

Replaces a range of points for this MeshKey.

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

Retrieves the number of points in this mesh.

Returns
The number of points in this mesh.
override HPS.Type HPS.MeshKey.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.GeometryKey.

void HPS.MeshKey.Set ( HPS.MeshKit  in_kit)
inline

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

Parameters
in_kitThe kit from which to get the settings to replace on this MeshKey.
HPS.MeshKey HPS.MeshKey.SetFaceIndexColorsByList ( ulong[]  in_faces,
float[]  in_indices 
)
inline

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

Parameters
in_facesThe indices of the faces on which to set the colors.
in_indicesThe material indices to set on the faces.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetFaceIndexColorsByList ( ulong[]  in_faces,
float  in_index 
)
inline

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

Parameters
in_facesThe indices of the faces on which to set the color.
in_indexThe material index to set on the faces.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetFaceIndexColorsByRange ( ulong  in_start,
float[]  in_indices 
)
inline

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

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

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

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting the color. This value must be such that in_start<face_count for setting to succeed.
in_countThe number of faces on which to set the color. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_indexThe material index to set on the faces for this MeshKey.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetFaceNormalsByList ( ulong[]  in_faces,
HPS.Vector[]  in_normals 
)
inline

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

Parameters
in_facesThe indices of the faces on which to set the normals.
in_normalsThe normals to set on the faces.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetFaceNormalsByList ( ulong[]  in_faces,
HPS.Vector  in_normal 
)
inline

Sets a single normal on a selection of arbitrary faces.

Parameters
in_facesThe indices of the faces on which to set the normal.
in_normalThe normal to set on the faces.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetFaceNormalsByRange ( ulong  in_start,
HPS.Vector[]  in_normals 
)
inline

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

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

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

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting the normal. This value must be such that in_start<face_count for setting to succeed.
in_countThe number of faces on which to set the normal. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_normalThe normal to set on the faces for this MeshKey.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetFaceRGBColorsByList ( ulong[]  in_faces,
HPS.RGBColor[]  in_rgb_colors 
)
inline

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

Parameters
in_facesThe indices of the faces on which to set the colors.
in_rgb_colorsThe RGB colors to set on the faces.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetFaceRGBColorsByList ( ulong[]  in_faces,
HPS.RGBColor  in_rgb_color 
)
inline

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

Parameters
in_facesThe indices of the faces on which to set the color.
in_rgb_colorThe RGB color to set on the faces.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetFaceRGBColorsByRange ( ulong  in_start,
HPS.RGBColor[]  in_rgb_colors 
)
inline

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

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

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

Parameters
in_startThe offset into the faces for this MeshKey at which to start setting the color. This value must be such that in_start<face_count for setting to succeed.
in_countThe number of faces on which to set the color. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_rgb_colorThe RGB color to set on the faces for this MeshKey.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetFaceVisibilitiesByList ( ulong[]  in_faces,
bool[]  in_visibilities 
)
inline

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

Parameters
in_facesThe indices of the faces on which to set the visibilities.
in_visibilitiesThe visibilities to set on the faces.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetFaceVisibilitiesByList ( ulong[]  in_faces,
bool  in_visibility 
)
inline

Sets a single visibility on a selection of arbitrary faces.

Parameters
in_facesThe indices of the faces on which to set the visibility.
in_visibilityThe visibility to set on the faces.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetFaceVisibilitiesByRange ( ulong  in_start,
bool[]  in_visibilities 
)
inline

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

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

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

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

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

Parameters
in_kitThe material mappings to set on this MeshKey.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetPoints ( ulong  in_rows,
ulong  in_columns,
HPS.Point[]  in_points 
)
inline

Replace the points on this MeshKey with the specified points.

Parameters
in_rowsThe number of rows for this MeshKey.
in_columnsThe number of columns for this MeshKey.
in_pointsThe points to use to replace those on this MeshKey.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexIndexColorsByList ( ulong[]  in_vertices,
float[]  in_indices,
HPS.Mesh.Component  in_apply_to 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_indicesThe material indices to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexIndexColorsByList ( ulong[]  in_vertices,
float[]  in_indices 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_indicesThe material indices to set on the vertices.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexIndexColorsByList ( ulong[]  in_vertices,
float  in_index,
HPS.Mesh.Component  in_apply_to 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the color.
in_indexThe material index to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexIndexColorsByList ( ulong[]  in_vertices,
float  in_index 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the color.
in_indexThe material index to set on the vertices.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexIndexColorsByRange ( ulong  in_start,
float[]  in_indices,
HPS.Mesh.Component  in_apply_to 
)
inline

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

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

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

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_indicesThe material indices to set on the vertices for this MeshKey. The size of the array must be such that in_start+in_indices.size()<=vertex_count for the setting to succeed.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexIndexColorsByRange ( ulong  in_start,
ulong  in_count,
float  in_index,
HPS.Mesh.Component  in_apply_to 
)
inline

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

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

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

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the color. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.
in_indexThe material index to set on the vertices for this MeshKey.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexNormalsByList ( ulong[]  in_vertices,
HPS.Vector[]  in_normals 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the normals.
in_normalsThe normals to set on the vertices.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexNormalsByList ( ulong[]  in_vertices,
HPS.Vector  in_normal 
)
inline

Sets a single normal on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to set the normal.
in_normalThe normal to set on the vertices.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexNormalsByRange ( ulong  in_start,
HPS.Vector[]  in_normals 
)
inline

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

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

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

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting the normal. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the normal. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.
in_normalThe normal to set on the vertices for this MeshKey.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexParametersByList ( ulong[]  in_vertices,
float[]  in_params,
ulong  in_param_width 
)
inline

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

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

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

Parameters
in_verticesThe indices of the vertices on which to set the texture parameters.
in_paramsThe texture parameters to set on the vertices for this MeshKey. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexParametersByRange ( ulong  in_start,
float[]  in_params,
ulong  in_param_width 
)
inline

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

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

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

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting texture parameters. This value must be such that in_start<point_count for setting to succeed.
in_paramsThe texture parameters to set on the vertices for this MeshKey. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored. This value must be such that in_start+in_params.size()/in_param_width<=point_count for the setting to succeed.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexRGBAColorsByList ( ulong[]  in_vertices,
HPS.RGBAColor[]  in_rgba_colors,
HPS.Mesh.Component  in_apply_to 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_rgba_colorsThe RGBA colors to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexRGBAColorsByList ( ulong[]  in_vertices,
HPS.RGBAColor[]  in_rgba_colors 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_rgba_colorsThe RGBA colors to set on the vertices.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexRGBAColorsByList ( ulong[]  in_vertices,
HPS.RGBAColor  in_rgba_color,
HPS.Mesh.Component  in_apply_to 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the color.
in_rgba_colorThe RGBA color to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexRGBAColorsByList ( ulong[]  in_vertices,
HPS.RGBAColor  in_rgba_color 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the color.
in_rgba_colorThe RGBA color to set on the vertices.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexRGBAColorsByRange ( ulong  in_start,
HPS.RGBAColor[]  in_rgba_colors,
HPS.Mesh.Component  in_apply_to 
)
inline

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

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

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

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_rgba_colorsThe RGBA colors to set on the vertices for this MeshKey. The size of the array must be such that in_start+in_rgba_colors.size()<=vertex_count for the setting to succeed.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexRGBAColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.RGBAColor  in_rgba_color,
HPS.Mesh.Component  in_apply_to 
)
inline

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

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

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

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the color. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.
in_rgba_colorThe RGBA color to set on the vertices for this MeshKey.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexRGBColorsByList ( ulong[]  in_vertices,
HPS.RGBColor[]  in_rgb_colors,
HPS.Mesh.Component  in_apply_to 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_rgb_colorsThe RGB colors to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexRGBColorsByList ( ulong[]  in_vertices,
HPS.RGBColor[]  in_rgb_colors 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_rgb_colorsThe RGB colors to set on the vertices.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexRGBColorsByList ( ulong[]  in_vertices,
HPS.RGBColor  in_rgb_color,
HPS.Mesh.Component  in_apply_to 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the color.
in_rgb_colorThe RGB color to set on the vertices.
in_apply_toThe mesh component the colors should apply to. Defaults to Mesh::Component::Faces.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexRGBColorsByList ( ulong[]  in_vertices,
HPS.RGBColor  in_rgb_color 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the color.
in_rgb_colorThe RGB color to set on the vertices.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexRGBColorsByRange ( ulong  in_start,
HPS.RGBColor[]  in_rgb_colors,
HPS.Mesh.Component  in_apply_to 
)
inline

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

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

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

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_rgb_colorsThe RGB colors to set on the vertices for this MeshKey. The size of the array must be such that in_start+in_rgb_colors.size()<=vertex_count for the setting to succeed.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexRGBColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.RGBColor  in_rgb_color,
HPS.Mesh.Component  in_apply_to 
)
inline

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

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

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

Parameters
in_startThe offset into the vertices for this MeshKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the color. This value must be such that in_start+in_count<=vertex_count for the setting to succeed.
in_rgb_colorThe RGB color to set on the vertices for this MeshKey.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexVisibilitiesByList ( ulong[]  in_vertices,
bool[]  in_visibilities 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the visibilities.
in_visibilitiesThe visibilities to set on the vertices.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexVisibilitiesByList ( ulong[]  in_vertices,
bool  in_visibility 
)
inline

Sets a single visibility on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to set the visibility.
in_visibilityThe visibility to set on the vertices.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.SetVertexVisibilitiesByRange ( ulong  in_start,
bool[]  in_visibilities 
)
inline

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

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

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

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

Copy the contents of this MeshKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this MeshKey.
bool HPS.MeshKey.ShowColumns ( out ulong  out_columns)
inline

Show the number of columns for this MeshKey.

Parameters
out_columnsThe number of columns for this MeshKey.
Returns
true if columns were set, false otherwise.
bool HPS.MeshKey.ShowFaceColors ( out HPS.Material.Type[]  out_types,
out HPS.RGBColor[]  out_rgb_colors,
out float[]  out_indices 
)
inline

Shows the face colors on MeshKey.

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

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

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

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

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

Shows all the face normals for this MeshKey.

Parameters
out_validitiesThe validities of the normals for each face. If a face had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normalsThe face normals for each face. out_normals[i] is only valid if out_validities[i] is true.
Returns
true if any face had a face normal set, false otherwise.
bool HPS.MeshKey.ShowFaceNormalsByList ( ulong[]  in_faces,
out bool[]  out_validities,
out HPS.Vector[]  out_normals 
)
inline

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

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

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

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

Shows all the face visibilities on this MeshKey.

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

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

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

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

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

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

Parameters
out_kitThe material mappings set on this MeshKey.
Returns
true if material mappings were set, false otherwise.
bool HPS.MeshKey.ShowPoints ( out HPS.Point[]  out_points)
inline

Show the points for this MeshKey.

Parameters
out_pointsThe points for this MeshKey.
Returns
true if points were set, false otherwise.
bool HPS.MeshKey.ShowPoints ( out ulong  out_rows,
out ulong  out_columns,
out HPS.Point[]  out_points 
)
inline

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

Parameters
out_rowsThe number of rows for this MeshKey.
out_columnsThe number of columns for this MeshKey.
out_pointsThe points for this MeshKey.
Returns
true if points were set, false otherwise.
bool HPS.MeshKey.ShowPointsByList ( ulong[]  in_indices,
out HPS.Point[]  out_points 
)
inline

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

Parameters
in_indicesThe list of point indices to show.
out_pointsThe requested points for this MeshKey.
Returns
true if all requested points were set, false otherwise.
bool HPS.MeshKey.ShowPointsByRange ( ulong  in_start_index,
ulong  in_count,
out HPS.Point[]  out_points 
)
inline

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

Parameters
in_start_indexThe first point to show.
in_countThe number of points to show.
out_pointsThe requested points for this MeshKey.
Returns
true if all requested points were set, false otherwise.
bool HPS.MeshKey.ShowRows ( out ulong  out_rows)
inline

Show the number of rows for this MeshKey.

Parameters
out_rowsThe number of rows for this MeshKey.
Returns
true if rows were set, false otherwise.
bool HPS.MeshKey.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 
)
inline

Shows all the vertex colors on the specified mesh component.

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

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

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

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

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

Shows all the vertex normals on this MeshKey.

Parameters
out_validitiesThe validities of the normals for each vertex. If a vertex had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normalsThe vertex normals for each vertex. out_normals[i] is only valid if out_validities[i] is true.
Returns
true if any vertex normals were shown, false otherwise.
bool HPS.MeshKey.ShowVertexNormalsByList ( ulong[]  in_vertices,
out bool[]  out_validities,
out HPS.Vector[]  out_normals 
)
inline

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Shows all the vertex visibilities on this MeshKey.

Parameters
out_validitiesThe validities of the visibilities for each vertex. If a vertex had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe vertex visibilities for each vertex. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any vertex had a vertex visibility set, false otherwise.
bool HPS.MeshKey.ShowVertexVisibilitiesByList ( ulong[]  in_vertices,
out bool[]  out_validities,
out bool[]  out_visibilities 
)
inline

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

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

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

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

Removes all settings from this MeshKey.

Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetFaceColors ( )
inline

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

Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetFaceColorsByList ( ulong[]  in_faces)
inline

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

Parameters
in_facesThe indices of the faces on which to remove the colors.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetFaceColorsByRange ( ulong  in_start,
ulong  in_count 
)
inline

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

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

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

Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetFaceNormals ( )
inline

Removes all face normals.

Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetFaceNormalsByList ( ulong[]  in_faces)
inline

Removes the face normals on a selection of arbitrary faces.

Parameters
in_facesThe indices of the faces on which to remove the normals.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetFaceNormalsByRange ( ulong  in_start,
ulong  in_count 
)
inline

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

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

Removes all face visibilities.

Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetFaceVisibilitiesByList ( ulong[]  in_faces)
inline

Removes the face visibilities on a selection of arbitrary faces.

Parameters
in_facesThe indices of the faces on which to remove the visibilities.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetFaceVisibilitiesByRange ( ulong  in_start,
ulong  in_count 
)
inline

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

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

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

Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetVertexColors ( )
inline

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

Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetVertexColors ( HPS.Mesh.Component  in_apply_to)
inline

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

Parameters
in_apply_toThe mesh component for which to remove the colors.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetVertexColorsByList ( ulong[]  in_vertices)
inline

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

Parameters
in_verticesThe indices of the vertices on which to remove the colors.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetVertexColorsByList ( ulong[]  in_vertices,
HPS.Mesh.Component  in_apply_to 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to remove the colors.
in_apply_toThe mesh component for which to remove the colors.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetVertexColorsByRange ( ulong  in_start,
ulong  in_count 
)
inline

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

Parameters
in_startThe offset into the vertices for this MeshKey at which to start removing colors. This value must be such that in_start<point_count for removal to succeed.
in_countThe number of vertex colors to unset for this MeshKey.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetVertexColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.Mesh.Component  in_apply_to 
)
inline

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

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

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

Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetVertexNormals ( )
inline

Removes all vertex normals.

Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetVertexNormalsByList ( ulong[]  in_vertices)
inline

Removes the vertex normals on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to remove the normals.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetVertexNormalsByRange ( ulong  in_start,
ulong  in_count 
)
inline

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

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

Removes all texture parameters.

Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetVertexParametersByList ( ulong[]  in_vertices)
inline

Removes the texture parameters on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to remove the texture parameters.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetVertexParametersByRange ( ulong  in_start,
ulong  in_count 
)
inline

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

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

Removes all vertex visibilities.

Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetVertexVisibilitiesByList ( ulong[]  in_vertices)
inline

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to remove the visibilities.
Returns
A reference to this MeshKey.
HPS.MeshKey HPS.MeshKey.UnsetVertexVisibilitiesByRange ( ulong  in_start,
ulong  in_count 
)
inline

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

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

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.MeshKey.cs