Overview

Sample Code

Programming Guide

API Reference

Support

HPS.ShellKit Class Reference

The ShellKit class is a user space object. It is the kit analog to a ShellKey. More...

Inheritance diagram for HPS.ShellKit:
HPS.Object

Public Member Functions

void ComputeRelation (HPS.Point[] in_points, HPS.ShellRelationOptionsKit in_options, out HPS.ShellRelationResultsKit out_results)
 Computes the relation of a collection of points to this shell, subject to the specified options. More...
 
void ComputeRelation (HPS.ShellKey in_points_source, HPS.ShellRelationOptionsKit in_options, out HPS.ShellRelationResultsKit out_results)
 Computes the relation of a collection of points to this shell, subject to the specified options. More...
 
void ComputeRelation (HPS.ShellKit in_points_source, HPS.ShellRelationOptionsKit in_options, out HPS.ShellRelationResultsKit out_results)
 Computes the relation of a collection of points to this shell, subject to the specified options. More...
 
void Consume (HPS.ShellKit in_kit)
 Copies the source ShellKit into this ShellKit and resets the source kit. More...
 
override void Dispose ()
 
HPS.ShellKit EditFacelistByDeletion (ulong in_offset, ulong in_count)
 Removes faces from the face list for this ShellKit. This will not affect the points referenced by the removed faces, however any face attributes on the removed faces will be lost. More...
 
HPS.ShellKit EditFacelistByInsertion (ulong in_offset, int[] in_facelist)
 Adds faces to the face list for this ShellKit. More...
 
HPS.ShellKit EditFacelistByReplacement (ulong in_offset, int[] in_facelist)
 Replaces faces in the face list for this ShellKit. More...
 
HPS.ShellKit EditPointsByDeletion (ulong in_offset, ulong in_count)
 Removes points from the point list for this ShellKit. Any existing faces which reference points which are being deleted will be removed. Additionally, any vertex attributes on the deleted vertices, i.e., colors, normals, parameters, and visibilities, will be removed. The face list will also be updated to reflect the new vertex offsets caused by removing elements from the point list. More...
 
HPS.ShellKit EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points)
 Adds points to the point list for this ShellKit. No existing faces will reference these points, i.e., the face list will be updated to reference the original vertices in their new positions. Addtionally, no vertex attributes will apply to these points, i.e., the vertex attributes will only be set on those points which had them prior to the insertion. More...
 
HPS.ShellKit EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)
 Replaces points in the point list for this ShellKit. These points will replace those already referenced by any faces and will inherit any attributes the points being replaced had. More...
 
override bool Empty ()
 Indicates whether this ShellKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ShellKit in_kit)
 Check if the source ShellKit is equivalent to this ShellKit. More...
 
ulong GetFaceCount ()
 Retrieves the number of faces in this shell. Note that this is different than the length of the face list More...
 
override int GetHashCode ()
 
ulong GetPointCount ()
 Retrieves the number of points in this shell. 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 Optimize (HPS.ShellOptimizationOptionsKit in_shell_optimization_kit)
 Optimizes the shell using the parameters set in a ShellOptimizationOptionsKit More...
 
void Set (HPS.ShellKit in_kit)
 Copies the source ShellKit into this ShellKit. More...
 
HPS.ShellKit 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.ShellKit SetFaceIndexColorsByList (ulong[] in_faces, float in_index)
 Sets a single material index on a selection of arbitrary faces. More...
 
HPS.ShellKit SetFaceIndexColorsByRange (ulong in_start, float[] in_indices)
 Sets face material indices on a range of faces starting at the specified offset. More...
 
HPS.ShellKit 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.ShellKit SetFacelist (int[] in_facelist)
 Sets the face list for this ShellKit. More...
 
HPS.ShellKit 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.ShellKit SetFaceNormalsByList (ulong[] in_faces, HPS.Vector in_normal)
 Sets a single normal on a selection of arbitrary faces. More...
 
HPS.ShellKit SetFaceNormalsByRange (ulong in_start, HPS.Vector[] in_normals)
 Sets face normals on a range of faces starting at the specified offset. More...
 
HPS.ShellKit 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.ShellKit 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.ShellKit SetFaceRGBColorsByList (ulong[] in_faces, HPS.RGBColor in_rgb_color)
 Sets a single RGB color on a selection of arbitrary faces. More...
 
HPS.ShellKit 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.ShellKit 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.ShellKit 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.ShellKit SetFaceVisibilitiesByList (ulong[] in_faces, bool in_visibility)
 Sets a single visibility on a selection of arbitrary faces. More...
 
HPS.ShellKit SetFaceVisibilitiesByRange (ulong in_start, bool[] in_visibilities)
 Sets face visibilities on a range of faces starting at the specified offset. More...
 
HPS.ShellKit 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.ShellKit SetMaterialMapping (HPS.MaterialMappingKit in_kit)
 Sets the specified material mappings on this ShellKit. If this kit is used to insert a shell, only face, back face, cut edge, cut face, edge, and vertex materials will be set on the inserted shell. These material settings will be "global" for the shell, 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.ShellKit SetPoints (HPS.Point[] in_points)
 Sets the points for this ShellKit. More...
 
HPS.ShellKit SetPriority (int in_priority)
 Assigns a specific drawing priority value to the ShellKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority. More...
 
HPS.ShellKit SetTristrips (int[] in_tristrips)
 Sets the triangle strips for this ShellKit. More...
 
HPS.ShellKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 Sets user data on this kit. More...
 
HPS.ShellKit SetUserData (IntPtr in_index, byte[] in_data)
 Sets user data on this kit. More...
 
HPS.ShellKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 Sets user data on this kit. More...
 
HPS.ShellKit SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices, HPS.Shell.Component in_apply_to)
 Sets vertex material indices on a selection of arbitrary vertices which apply to the specified shell component. If the sizes of the vertex index and material index arrays are different, the smaller size will be used. More...
 
HPS.ShellKit SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices)
 Sets vertex material indices on a selection of arbitrary vertices which apply to the specified shell component. If the sizes of the vertex index and material index arrays are different, the smaller size will be used. More...
 
HPS.ShellKit SetVertexIndexColorsByList (ulong[] in_vertices, float in_index, HPS.Shell.Component in_apply_to)
 Sets a single material index on a selection of arbitrary vertices which apply to the specified shell component. More...
 
HPS.ShellKit SetVertexIndexColorsByList (ulong[] in_vertices, float in_index)
 Sets a single material index on a selection of arbitrary vertices which apply to the specified shell component. More...
 
HPS.ShellKit SetVertexIndexColorsByRange (ulong in_start, float[] in_indices, HPS.Shell.Component in_apply_to)
 Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified shell component. More...
 
HPS.ShellKit 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 shell component. More...
 
HPS.ShellKit SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index, HPS.Shell.Component in_apply_to)
 Sets a single material index on a range of vertices starting at the specified offset which apply to the specified shell component. More...
 
HPS.ShellKit 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 shell component. More...
 
HPS.ShellKit 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.ShellKit SetVertexNormalsByList (ulong[] in_vertices, HPS.Vector in_normal)
 Sets a single normal on a selection of arbitrary vertices. More...
 
HPS.ShellKit SetVertexNormalsByRange (ulong in_start, HPS.Vector[] in_normals)
 Sets vertex normals on a range of vertices starting at the specified offset. More...
 
HPS.ShellKit 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.ShellKit 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.ShellKit 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.ShellKit 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.ShellKit SetVertexParametersByRange (ulong in_start, float[] in_params)
 Sets texture parameters on a range of vertices starting at the specified offset. More...
 
HPS.ShellKit SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor[] in_rgba_colors, HPS.Shell.Component in_apply_to)
 Sets vertex RGBA colors on a selection of arbitrary vertices which apply to the specified shell component. If the sizes of the vertex index array and color array are different, the smaller size will be used. More...
 
HPS.ShellKit SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor[] in_rgba_colors)
 Sets vertex RGBA colors on a selection of arbitrary vertices which apply to the specified shell component. If the sizes of the vertex index array and color array are different, the smaller size will be used. More...
 
HPS.ShellKit SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor in_rgba_color, HPS.Shell.Component in_apply_to)
 Sets a single RGBA color on a selection of arbitrary vertices which apply to the specified shell component. More...
 
HPS.ShellKit 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 shell component. More...
 
HPS.ShellKit SetVertexRGBAColorsByRange (ulong in_start, HPS.RGBAColor[] in_rgba_colors, HPS.Shell.Component in_apply_to)
 Sets vertex RGBA colors on a range of vertices starting at the specified offset which apply to the specified shell component. More...
 
HPS.ShellKit 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 shell component. More...
 
HPS.ShellKit SetVertexRGBAColorsByRange (ulong in_start, ulong in_count, HPS.RGBAColor in_rgba_color, HPS.Shell.Component in_apply_to)
 Sets a single RGBA color on a range of vertices starting at the specified offset which apply to the specified shell component. More...
 
HPS.ShellKit 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 shell component. More...
 
HPS.ShellKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors, HPS.Shell.Component in_apply_to)
 Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified shell component. If the sizes of the vertex index array and the color array different, the smaller size will be used. More...
 
HPS.ShellKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors)
 Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified shell component. If the sizes of the vertex index array and the color array different, the smaller size will be used. More...
 
HPS.ShellKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color, HPS.Shell.Component in_apply_to)
 Sets a single RGB color on a selection of arbitrary vertices which apply to the specified shell component. More...
 
HPS.ShellKit 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 shell component. More...
 
HPS.ShellKit SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors, HPS.Shell.Component in_apply_to)
 Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified shell component. More...
 
HPS.ShellKit 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 shell component. More...
 
HPS.ShellKit SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color, HPS.Shell.Component in_apply_to)
 Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified shell component. More...
 
HPS.ShellKit 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 shell component. More...
 
HPS.ShellKit 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.ShellKit SetVertexVisibilitiesByList (ulong[] in_vertices, bool in_visibility)
 Sets a single visibility on a selection of arbitrary vertices. More...
 
HPS.ShellKit SetVertexVisibilitiesByRange (ulong in_start, bool[] in_visibilities)
 Sets vertex visibilities on a range of vertices starting at the specified offset. More...
 
HPS.ShellKit 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...
 
 ShellKit ()
 The default constructor creates an empty ShellKit object. More...
 
 ShellKit (HPS.ShellKit in_kit)
 The copy constructor creates a new ShellKit object that contains the same settings as the source ShellKit. More...
 
void Show (out HPS.ShellKit out_kit)
 Copies this ShellKit into the given ShellKit. More...
 
bool ShowFaceColors (out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)
 Shows all the face colors on this ShellKit. 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 ShowFacelist (out int[] out_facelist)
 Show the face list for this ShellKit. More...
 
bool ShowFaceNormals (out bool[] out_validities, out HPS.Vector[] out_normals)
 Shows the all face normals on this ShellKit. 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 ShellKit. 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 ShellKit. 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 ShellKit. More...
 
bool ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points)
 Show a subset of the points for this ShellKit 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 ShellKit by range. More...
 
bool ShowPriority (out int out_priority)
 Shows the drawing priority. More...
 
bool ShowTristrips (out int[] out_tristrips)
 Show the tristrips list for this ShellKit. More...
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 Shows the user data at a given index for this kit. More...
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 Shows all user data for this kit. More...
 
ulong ShowUserDataCount ()
 Get the number of user data indices set on this kit. More...
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 Shows the indices of all user data set on this kit. More...
 
bool ShowVertexColors (HPS.Shell.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 shell component. More...
 
bool ShowVertexColorsByList (ulong[] in_vertices, HPS.Shell.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 shell 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.Shell.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 shell component. More...
 
bool ShowVertexNormals (out bool[] out_validities, out HPS.Vector[] out_normals)
 Shows all the vertex normals on this ShellKit. 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 on all of the vertices in this ShellKit. 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 on all of the vertices in this ShellKit. 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 ShellKit 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.ShellKit UnsetAllUserData ()
 Removes all user data from this kit. More...
 
HPS.ShellKit UnsetEverything ()
 Removes all settings from this ShellKit. More...
 
HPS.ShellKit UnsetFaceColors ()
 Removes all face colors (RGB colors or material indices). More...
 
HPS.ShellKit UnsetFaceColorsByList (ulong[] in_faces)
 Removes the face colors (RGB colors or material indices) on a selection of arbitrary vertices. More...
 
HPS.ShellKit 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.ShellKit UnsetFaceEverything ()
 Removes all face settings (face colors, face normals, and face visibilities) from this ShellKit. More...
 
HPS.ShellKit UnsetFacelist ()
 Removes the face list for this ShellKit. More...
 
HPS.ShellKit UnsetFaceNormals ()
 Removes all face normals. More...
 
HPS.ShellKit UnsetFaceNormalsByList (ulong[] in_vertices)
 Removes the face normals on a selection of arbitrary faces. More...
 
HPS.ShellKit UnsetFaceNormalsByRange (ulong in_start, ulong in_count)
 Removes the specified range of face normals starting at the specified offset. More...
 
HPS.ShellKit UnsetFaceVisibilities ()
 Removes all face visibilities. More...
 
HPS.ShellKit UnsetFaceVisibilitiesByList (ulong[] in_vertices)
 Removes the face visibilities on a selection of arbitrary faces. More...
 
HPS.ShellKit UnsetFaceVisibilitiesByRange (ulong in_start, ulong in_count)
 Removes the specified range of face visibilities starting at the specified offset. More...
 
HPS.ShellKit UnsetMaterialMapping ()
 Removes all material mappings on this ShellKit. This removes the "global" material settings and does not affect per-vertex or per-face materials. More...
 
HPS.ShellKit UnsetPoints ()
 Removes the points for this ShellKit. More...
 
HPS.ShellKit UnsetPriority ()
 Removes a drawing priority setting. More...
 
HPS.ShellKit UnsetTristrips ()
 Removes the tristrips list for this ShellKit. More...
 
HPS.ShellKit UnsetUserData (IntPtr in_index)
 Removes the user data at the given index from this kit. More...
 
HPS.ShellKit UnsetUserData (IntPtr[] in_indices)
 Removes the user data at the given indices from this kit. More...
 
HPS.ShellKit UnsetVertexColors ()
 Removes all vertex colors (RGB colors, RGBA colors, or material indices) for all shell components. More...
 
HPS.ShellKit UnsetVertexColors (HPS.Shell.Component in_apply_to)
 Removes all vertex colors (RGB colors, RGBA colors, or material indices) for the specified shell component. More...
 
HPS.ShellKit UnsetVertexColorsByList (ulong[] in_vertices)
 Removes the vertex colors (RGB colors, RGBA colors, or material indices) for all shell components on a selection of arbitrary vertices. More...
 
HPS.ShellKit UnsetVertexColorsByList (ulong[] in_vertices, HPS.Shell.Component in_apply_to)
 Removes the vertex colors (RGB colors, RGBA colors, or material indices) for the specified shell component on a selection of arbitrary vertices. More...
 
HPS.ShellKit UnsetVertexColorsByRange (ulong in_start, ulong in_count)
 Removes the specified range of vertex colors (RGB colors, RGBA colors, or material indices) for all shell components starting at the specified offset. More...
 
HPS.ShellKit UnsetVertexColorsByRange (ulong in_start, ulong in_count, HPS.Shell.Component in_apply_to)
 Removes the specified range of vertex colors (RGB colors, RGBA colors, or material indices) for the specified shell component starting at the specified offset. More...
 
HPS.ShellKit UnsetVertexEverything ()
 Removes all vertex settings (vertex colors, vertex normals, texture parameters, and vertex visibilities) from this ShellKit. More...
 
HPS.ShellKit UnsetVertexNormals ()
 Removes all vertex normals. More...
 
HPS.ShellKit UnsetVertexNormalsByList (ulong[] in_vertices)
 Removes the vertex normals on a selection of arbitrary vertices. More...
 
HPS.ShellKit UnsetVertexNormalsByRange (ulong in_start, ulong in_count)
 Removes the specified range of vertex normals starting at the specified offset. More...
 
HPS.ShellKit UnsetVertexParameters ()
 Removes all texture parameters. More...
 
HPS.ShellKit UnsetVertexParametersByList (ulong[] in_vertices)
 Removes the texture parameters on a selection of arbitrary vertices. More...
 
HPS.ShellKit UnsetVertexParametersByRange (ulong in_start, ulong in_count)
 Removes the specified range of texture parameters starting at the specified offset. More...
 
HPS.ShellKit UnsetVertexVisibilities ()
 Removes all vertex visibilities. More...
 
HPS.ShellKit UnsetVertexVisibilitiesByList (ulong[] in_vertices)
 Removes the vertex visibilities on a selection of arbitrary vertices. More...
 
HPS.ShellKit 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.Object
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...
 

Static Public Member Functions

static bool operator!= (HPS.ShellKit a, HPS.ShellKit b)
 
static bool operator== (HPS.ShellKit a, HPS.ShellKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The ShellKit class is a user space object. It is the kit analog to a ShellKey.

Constructor & Destructor Documentation

HPS.ShellKit.ShellKit ( )
inline

The default constructor creates an empty ShellKit object.

HPS.ShellKit.ShellKit ( HPS.ShellKit  in_kit)
inline

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

Parameters
in_kitThe source ShellKit to copy.

Member Function Documentation

void HPS.ShellKit.ComputeRelation ( HPS.Point[]  in_points,
HPS.ShellRelationOptionsKit  in_options,
out HPS.ShellRelationResultsKit  out_results 
)
inline

Computes the relation of a collection of points to this shell, subject to the specified options.

Parameters
in_pointsAn array of points to test against this shell.
in_optionsThe options to use when performing the relation test.
out_resultsThe results of the relation test.
void HPS.ShellKit.ComputeRelation ( HPS.ShellKey  in_points_source,
HPS.ShellRelationOptionsKit  in_options,
out HPS.ShellRelationResultsKit  out_results 
)
inline

Computes the relation of a collection of points to this shell, subject to the specified options.

Parameters
in_points_sourceA shell whose points should be tested against this shell.
in_optionsThe options to use when performing the relation test.
out_resultsThe results of the relation test.
void HPS.ShellKit.ComputeRelation ( HPS.ShellKit  in_points_source,
HPS.ShellRelationOptionsKit  in_options,
out HPS.ShellRelationResultsKit  out_results 
)
inline

Computes the relation of a collection of points to this shell, subject to the specified options.

Parameters
in_points_sourceA shell whose points should be tested against this shell.
in_optionsThe options to use when performing the relation test.
out_resultsThe results of the relation test.
void HPS.ShellKit.Consume ( HPS.ShellKit  in_kit)
inline

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

Parameters
in_kitThe source ShellKit to consume.
HPS.ShellKit HPS.ShellKit.EditFacelistByDeletion ( ulong  in_offset,
ulong  in_count 
)
inline

Removes faces from the face list for this ShellKit. This will not affect the points referenced by the removed faces, however any face attributes on the removed faces will be lost.

Parameters
in_offsetThe offset into the faces for the shell at which to start removing faces. This value must be such that in_offset<face_count for deletion to succeed. This is not an offset into the raw face list, but is relative to the actual face count for the shell.
in_countThe number of faces to remove from the face list for the shell. This value must be such that in_offset+in_count<=face_count for the deletion to succeed.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.EditFacelistByInsertion ( ulong  in_offset,
int[]  in_facelist 
)
inline

Adds faces to the face list for this ShellKit.

Parameters
in_offsetThe offset into the faces for the shell at which to insert faces. This value must be such that in_offset<face_count for insertion to succeed. This is not an offset into the raw face list, but is relative to the actual face count for the shell.
in_facelistThe faces (using the standard face-list encoding) to insert into the face list at the specified offset.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.EditFacelistByReplacement ( ulong  in_offset,
int[]  in_facelist 
)
inline

Replaces faces in the face list for this ShellKit.

Parameters
in_offsetThe offset into the faces for the shell at which to start replacing faces. This value must be such that in_offset<face_count for replacement to succeed. This is not an offset into the raw face list, but is relative to the actual face count for the shell.
in_facelistThe faces (using the standard face-list encoding) to use to replace those in the face list at the specified offset. The number of replacement faces must be such that in_offset+replacement_face_count<=face_count. This does not mean that the face list length must be the same, i.e., faces can use different numbers of vertices than previously, but rather is a limit on the number of faces encoded in the face list.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.EditPointsByDeletion ( ulong  in_offset,
ulong  in_count 
)
inline

Removes points from the point list for this ShellKit. Any existing faces which reference points which are being deleted will be removed. Additionally, any vertex attributes on the deleted vertices, i.e., colors, normals, parameters, and visibilities, will be removed. The face list will also be updated to reflect the new vertex offsets caused by removing elements from the point list.

Parameters
in_offsetThe offset into the point list for the shell at which to start removing points. This value must be such that in_offset<point_count for deletion to succeed.
in_countThe number of points to delete from the point list for the shell. This value must be such that in_offset+in_count<=point_count for the deletion to succeed.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.EditPointsByInsertion ( ulong  in_offset,
HPS.Point[]  in_points 
)
inline

Adds points to the point list for this ShellKit. No existing faces will reference these points, i.e., the face list will be updated to reference the original vertices in their new positions. Addtionally, no vertex attributes will apply to these points, i.e., the vertex attributes will only be set on those points which had them prior to the insertion.

Parameters
in_offsetThe offset into the point list for the shell at which to insert points. This value must be such that in_offset<point_count for insertion to succeed.
in_pointsThe points to insert into the point list at the specified offset.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.EditPointsByReplacement ( ulong  in_offset,
HPS.Point[]  in_points 
)
inline

Replaces points in the point list for this ShellKit. These points will replace those already referenced by any faces and will inherit any attributes the points being replaced had.

Parameters
in_offsetThe offset into the point list for the shell at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed.
in_pointsThe points to use to replace those in the point list at the specified offset. This size of the array must be such that in_offset+in_points.size()<=point_count for the replacement to succeed.
Returns
A reference to this ShellKit.
override bool HPS.ShellKit.Empty ( )
inlinevirtual

Indicates whether this ShellKit has any values set on it.

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

Reimplemented from HPS.Object.

bool HPS.ShellKit.Equals ( HPS.ShellKit  in_kit)
inline

Check if the source ShellKit is equivalent to this ShellKit.

Parameters
in_kitThe source ShellKit to compare to this ShellKit.
Returns
true if the objects are equivalent, false otherwise.
ulong HPS.ShellKit.GetFaceCount ( )
inline

Retrieves the number of faces in this shell. Note that this is different than the length of the face list

Returns
The number of faces in this shell.
ulong HPS.ShellKit.GetPointCount ( )
inline

Retrieves the number of points in this shell.

Returns
The number of points in this shell.
override HPS.Type HPS.ShellKit.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.Object.

void HPS.ShellKit.Optimize ( HPS.ShellOptimizationOptionsKit  in_shell_optimization_kit)
inline

Optimizes the shell using the parameters set in a ShellOptimizationOptionsKit

void HPS.ShellKit.Set ( HPS.ShellKit  in_kit)
inline

Copies the source ShellKit into this ShellKit.

Parameters
in_kitThe source ShellKit to copy.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start setting colors.
in_indicesThe material indices to set on the faces for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start setting the color.
in_countThe number of faces on which to set the color.
in_indexThe material index to set on the faces for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.SetFacelist ( int[]  in_facelist)
inline

Sets the face list for this ShellKit.

Parameters
in_facelistThe face list for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start setting normals.
in_normalsThe normals to set on the faces for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start setting the normal.
in_countThe number of faces on which to set the normal.
in_normalThe normal to set on the faces for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start setting colors.
in_rgb_colorsThe RGB colors to set on the faces for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start setting the color.
in_countThe number of faces on which to set the color.
in_rgb_colorThe RGB color to set on the faces for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start setting visibilities.
in_visibilitiesThe visibilities to set on the faces for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start setting the visibility.
in_countThe number of faces on which to set the visibility.
in_visibilityThe visibility to set on the faces for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.SetMaterialMapping ( HPS.MaterialMappingKit  in_kit)
inline

Sets the specified material mappings on this ShellKit. If this kit is used to insert a shell, only face, back face, cut edge, cut face, edge, and vertex materials will be set on the inserted shell. These material settings will be "global" for the shell, 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 ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.SetPoints ( HPS.Point[]  in_points)
inline

Sets the points for this ShellKit.

Parameters
in_pointsThe points for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.SetPriority ( int  in_priority)
inline

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

Parameters
in_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.

SubwindowKit::SetPriority()

SubwindowKit::SetRenderingAlgorithm()

HPS.ShellKit HPS.ShellKit.SetTristrips ( int[]  in_tristrips)
inline

Sets the triangle strips for this ShellKit.

Parameters
in_tristripsThe tristrips list for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.SetUserData ( IntPtr  in_index,
ulong  in_bytes,
byte[]  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.
HPS.ShellKit HPS.ShellKit.SetUserData ( IntPtr  in_index,
byte[]  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.
HPS.ShellKit HPS.ShellKit.SetUserData ( IntPtr[]  in_indices,
byte  in_data[][] 
)
inline

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.
HPS.ShellKit HPS.ShellKit.SetVertexIndexColorsByList ( ulong[]  in_vertices,
float[]  in_indices,
HPS.Shell.Component  in_apply_to 
)
inline

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified shell 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 shell component the colors should apply to. Defaults to Shell::Component::Faces.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.SetVertexIndexColorsByList ( ulong[]  in_vertices,
float[]  in_indices 
)
inline

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified shell 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 ShellKit.
HPS.ShellKit HPS.ShellKit.SetVertexIndexColorsByList ( ulong[]  in_vertices,
float  in_index,
HPS.Shell.Component  in_apply_to 
)
inline

Sets a single material index on a selection of arbitrary vertices which apply to the specified shell 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 shell component the colors should apply to. Defaults to Shell::Component::Faces.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.SetVertexIndexColorsByList ( ulong[]  in_vertices,
float  in_index 
)
inline

Sets a single material index on a selection of arbitrary vertices which apply to the specified shell 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 ShellKit.
HPS.ShellKit HPS.ShellKit.SetVertexIndexColorsByRange ( ulong  in_start,
float[]  in_indices,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKit at which to start setting colors.
in_indicesThe material indices to set on the vertices for this ShellKit.
in_apply_toThe shell component the colors should apply to. Defaults to Shell::Component::Faces.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 shell component.

Parameters
in_startThe offset into the vertices for this ShellKit at which to start setting colors.
in_indicesThe material indices to set on the vertices for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.SetVertexIndexColorsByRange ( ulong  in_start,
ulong  in_count,
float  in_index,
HPS.Shell.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 shell component.

Parameters
in_startThe offset into the vertices for this ShellKit at which to start setting the color.
in_countThe number of vertices on which to set the color.
in_indexThe material index to set on the vertices for this ShellKit.
in_apply_toThe shell component the colors should apply to. Defaults to Shell::Component::Faces.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 shell component.

Parameters
in_startThe offset into the vertices for this ShellKit at which to start setting the color.
in_countThe number of vertices on which to set the color.
in_indexThe material index to set on the vertices for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start setting normals.
in_normalsThe normals to set on the vertices for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start setting the normal.
in_countThe number of vertices on which to set the normal.
in_normalThe normal to set on the vertices for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit. 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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit. 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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start setting texture parameters.
in_paramsThe texture parameters to set on the vertices for this ShellKit. 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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start setting texture parameters.
in_paramsThe texture parameters to set on the vertices for this ShellKit. 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 ShellKit.
HPS.ShellKit HPS.ShellKit.SetVertexRGBAColorsByList ( ulong[]  in_vertices,
HPS.RGBAColor[]  in_rgba_colors,
HPS.Shell.Component  in_apply_to 
)
inline

Sets vertex RGBA colors on a selection of arbitrary vertices which apply to the specified shell 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 shell component the colors should apply to. Defaults to Shell::Component::Faces.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 shell 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 ShellKit.
HPS.ShellKit HPS.ShellKit.SetVertexRGBAColorsByList ( ulong[]  in_vertices,
HPS.RGBAColor  in_rgba_color,
HPS.Shell.Component  in_apply_to 
)
inline

Sets a single RGBA color on a selection of arbitrary vertices which apply to the specified shell 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 shell component the colors should apply to. Defaults to Shell::Component::Faces.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 shell 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 ShellKit.
HPS.ShellKit HPS.ShellKit.SetVertexRGBAColorsByRange ( ulong  in_start,
HPS.RGBAColor[]  in_rgba_colors,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKit at which to start setting colors.
in_rgba_colorsThe RGBA colors to set on the vertices for this ShellKit.
in_apply_toThe shell component the colors should apply to. Defaults to Shell::Component::Faces.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 shell component.

Parameters
in_startThe offset into the vertices for this ShellKit at which to start setting colors.
in_rgba_colorsThe RGBA colors to set on the vertices for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.SetVertexRGBAColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.RGBAColor  in_rgba_color,
HPS.Shell.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 shell component.

Parameters
in_startThe offset into the vertices for this ShellKit at which to start setting the color.
in_countThe number of vertices on which to set the color.
in_rgba_colorThe RGBA color to set on the vertices for this ShellKit.
in_apply_toThe shell component the colors should apply to. Defaults to Shell::Component::Faces.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 shell component.

Parameters
in_startThe offset into the vertices for this ShellKit at which to start setting the color.
in_countThe number of vertices on which to set the color.
in_rgba_colorThe RGBA color to set on the vertices for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.SetVertexRGBColorsByList ( ulong[]  in_vertices,
HPS.RGBColor[]  in_rgb_colors,
HPS.Shell.Component  in_apply_to 
)
inline

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified shell 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 shell component the colors should apply to. Defaults to Shell::Component::Faces.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 shell 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 ShellKit.
HPS.ShellKit HPS.ShellKit.SetVertexRGBColorsByList ( ulong[]  in_vertices,
HPS.RGBColor  in_rgb_color,
HPS.Shell.Component  in_apply_to 
)
inline

Sets a single RGB color on a selection of arbitrary vertices which apply to the specified shell 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 shell component the colors should apply to. Defaults to Shell::Component::Faces.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 shell 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 ShellKit.
HPS.ShellKit HPS.ShellKit.SetVertexRGBColorsByRange ( ulong  in_start,
HPS.RGBColor[]  in_rgb_colors,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKit at which to start setting colors.
in_rgb_colorsThe RGB colors to set on the vertices for this ShellKit.
in_apply_toThe shell component the colors should apply to. Defaults to Shell::Component::Faces.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 shell component.

Parameters
in_startThe offset into the vertices for this ShellKit at which to start setting colors.
in_rgb_colorsThe RGB colors to set on the vertices for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.SetVertexRGBColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.RGBColor  in_rgb_color,
HPS.Shell.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 shell component.

Parameters
in_startThe offset into the vertices for this ShellKit at which to start setting the color.
in_countThe number of vertices on which to set the color.
in_rgb_colorThe RGB color to set on the vertices for this ShellKit.
in_apply_toThe shell component the colors should apply to. Defaults to Shell::Component::Faces.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 shell component.

Parameters
in_startThe offset into the vertices for this ShellKit at which to start setting the color.
in_countThe number of vertices on which to set the color.
in_rgb_colorThe RGB color to set on the vertices for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start setting visibilities.
in_visibilitiesThe visibilities to set on the vertices for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start setting the visibility.
in_countThe number of vertices on which to set the visibility.
in_visibilityThe visibility to set on the vertices for this ShellKit.
Returns
A reference to this ShellKit.
void HPS.ShellKit.Show ( out HPS.ShellKit  out_kit)
inline

Copies this ShellKit into the given ShellKit.

Parameters
out_kitThe ShellKit to populate with the contents of this ShellKit.
bool HPS.ShellKit.ShowFaceColors ( out HPS.Material.Type[]  out_types,
out HPS.RGBColor[]  out_rgb_colors,
out float[]  out_indices 
)
inline

Shows all the face colors on this ShellKit.

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.ShellKit.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.ShellKit.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 ShellKit at which to start showing colors.
in_countThe number of colors to show.
out_typesThe types of face colors for each face in the specified range. If a face in the specified range does not have a face color set, the entry in this array will be Material::Type::None.
out_rgb_colorsThe RGB colors for each face in the specified range. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_indicesThe material indices for each face in the specified range. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.
Returns
true if any face in the specified range had a face color set, false otherwise.
bool HPS.ShellKit.ShowFacelist ( out int[]  out_facelist)
inline

Show the face list for this ShellKit.

Parameters
out_facelistThe face list for this ShellKit.
Returns
true if face list was set, false otherwise.
bool HPS.ShellKit.ShowFaceNormals ( out bool[]  out_validities,
out HPS.Vector[]  out_normals 
)
inline

Shows the all face normals on this ShellKit.

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.ShellKit.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.ShellKit.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 ShellKit at which to start showing normals.
in_countThe number of normals to show.
out_validitiesThe validities of the normals for each face in the specified range. If a face in the specified range had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normalsThe face normals for each face in the specified range. out_normals[i] is only valid if out_validities[i] is true.
Returns
true if any face in the specified range had a face normal set, false otherwise.
bool HPS.ShellKit.ShowFaceVisibilities ( out bool[]  out_validities,
out bool[]  out_visibilities 
)
inline

Shows all the face visibilities on this ShellKit.

Parameters
out_validitiesThe validities of the visibilities for each face. If a face had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe face visibilities for each face. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any face had a face visibility set, false otherwise.
bool HPS.ShellKit.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.ShellKit.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 ShellKit at which to start showing visibilities.
in_countThe number of visibilities to show.
out_validitiesThe validities of the visibilities for each face in the specified range. If a face in the specified range had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe face visibilities for each face in the specified range. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any face in the specified range had a face visibility set, false otherwise.
bool HPS.ShellKit.ShowMaterialMapping ( out HPS.MaterialMappingKit  out_kit)
inline

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

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

Show the points for this ShellKit.

Parameters
out_pointsThe points for this ShellKit.
Returns
true if points were set, false otherwise.
bool HPS.ShellKit.ShowPointsByList ( ulong[]  in_indices,
out HPS.Point[]  out_points 
)
inline

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

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

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

Parameters
in_start_indexThe first point to show.
in_countThe number of points to show.
out_pointsThe requested points for this ShellKit.
Returns
true if all requested points were set, false otherwise.
bool HPS.ShellKit.ShowPriority ( out int  out_priority)
inline

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if the setting is valid, false otherwise.
bool HPS.ShellKit.ShowTristrips ( out int[]  out_tristrips)
inline

Show the tristrips list for this ShellKit.

Parameters
out_tristripsThe face list for this ShellKit.
Returns
true if tristrips list was set, false otherwise.
bool HPS.ShellKit.ShowUserData ( IntPtr  in_index,
out byte[]  out_data 
)
inline

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

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.
bool HPS.ShellKit.ShowUserData ( out IntPtr[]  out_indices,
out byte  out_data[][] 
)
inline

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn array of all user data set on this kit.
Returns
true if there is user data on this kit, false otherwise.
ulong HPS.ShellKit.ShowUserDataCount ( )
inline

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

bool HPS.ShellKit.ShowUserDataIndices ( out IntPtr[]  out_indices)
inline

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

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.
bool HPS.ShellKit.ShowVertexColors ( HPS.Shell.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 shell component.

Parameters
in_apply_toThe shell 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 shell 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.ShellKit.ShowVertexColorsByList ( ulong[]  in_vertices,
HPS.Shell.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 shell 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 shell 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.ShellKit.ShowVertexColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.Shell.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 shell component.

Parameters
in_startThe offset into the vertices for this ShellKit at which to start showing colors.
in_countThe number of colors to show.
in_apply_toThe shell 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 shell 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.ShellKit.ShowVertexNormals ( out bool[]  out_validities,
out HPS.Vector[]  out_normals 
)
inline

Shows all the vertex normals on this ShellKit.

Parameters
out_validitiesThe validities of the normals for each vertexe. 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.ShellKit.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.ShellKit.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 ShellKit at which to start showing normals.
in_countThe number of normals to show.
out_validitiesThe validities of the normals for each vertex in the specified range. If a vertex in the specified range had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normalsThe vertex normals for each vertex in the specified range. out_normals[i] is only valid if out_validities[i] is true.
Returns
true if any vertex in the specified range had a vertex normal set, false otherwise.
bool HPS.ShellKit.ShowVertexParameters ( out bool[]  out_validities,
out float[]  out_params 
)
inline

Shows the texture parameters on all of the vertices in this ShellKit. 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.ShellKit.ShowVertexParameters ( out bool[]  out_validities,
out float[]  out_params,
out ulong  out_param_width 
)
inline

Shows the texture parameters on all of the vertices in this ShellKit.

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.ShellKit.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.ShellKit.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.ShellKit.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 ShellKit at which to start showing texture parameters.
in_countThe number of vertices for which to show the texture parameters.
out_validitiesThe validities of the texture parameters for each vertex in the specified range. If a vertex in the specified range had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_paramsThe texture parameters for each vertex in the specified range. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
Returns
true if any vertex in the specified range had a texture parameter set, false otherwise.
bool HPS.ShellKit.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 ShellKit at which to start showing texture parameters.
in_countThe number of vertices for which to show the texture parameters.
out_validitiesThe validities of the texture parameters for each vertex in the specified range. If a vertex in the specified range had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_paramsThe texture parameters for each vertex in the specified range. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
out_param_widthThe number of texture parameters per vertex.
Returns
true if any vertex in the specified range had a texture parameter set, false otherwise.
bool HPS.ShellKit.ShowVertexVisibilities ( out bool[]  out_validities,
out bool[]  out_visibilities 
)
inline

Shows all the vertex visibilities on this ShellKit

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.ShellKit.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.ShellKit.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 ShellKit at which to start showing visibilities.
in_countThe number of visibilities to show.
out_validitiesThe validities of the visibilities for each vertex in the specified range. If a vertex in the specified range had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe vertex visibilities for each vertex in the specified range. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any vertex in the specified range had a vertex visibility set, false otherwise.
HPS.ShellKit HPS.ShellKit.UnsetAllUserData ( )
inline

Removes all user data from this kit.

Returns
A reference to this kit.
HPS.ShellKit HPS.ShellKit.UnsetEverything ( )
inline

Removes all settings from this ShellKit.

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

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

Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start removing colors.
in_countThe number of face colors to remove for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetFaceEverything ( )
inline

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

Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetFacelist ( )
inline

Removes the face list for this ShellKit.

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

Removes all face normals.

Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetFaceNormalsByList ( ulong[]  in_vertices)
inline

Removes the face normals on a selection of arbitrary faces.

Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start removing normals.
in_countThe number of face normals to remove for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetFaceVisibilities ( )
inline

Removes all face visibilities.

Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetFaceVisibilitiesByList ( ulong[]  in_vertices)
inline

Removes the face visibilities on a selection of arbitrary faces.

Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start removing visibilities.
in_countThe number of face visibilities to remove for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetMaterialMapping ( )
inline

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

Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetPoints ( )
inline

Removes the points for this ShellKit.

Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.
HPS.ShellKit HPS.ShellKit.UnsetTristrips ( )
inline

Removes the tristrips list for this ShellKit.

Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetUserData ( IntPtr  in_index)
inline

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

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.
HPS.ShellKit HPS.ShellKit.UnsetUserData ( IntPtr[]  in_indices)
inline

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

Parameters
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.
HPS.ShellKit HPS.ShellKit.UnsetVertexColors ( )
inline

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

Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetVertexColors ( HPS.Shell.Component  in_apply_to)
inline

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

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

Removes the vertex colors (RGB colors, RGBA colors, or material indices) for all shell 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 ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetVertexColorsByList ( ulong[]  in_vertices,
HPS.Shell.Component  in_apply_to 
)
inline

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

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

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

Parameters
in_startThe offset into the vertices for this ShellKit at which to start removing colors.
in_countThe number of vertex colors to remove for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetVertexColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKit at which to start removing colors.
in_countThe number of vertex colors to remove for this ShellKit.
in_apply_toThe shell component for which to remove the colors.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetVertexEverything ( )
inline

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

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

Removes all vertex normals.

Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start removing normals.
in_countThe number of vertex normals to remove for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetVertexParameters ( )
inline

Removes all texture parameters.

Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit.
HPS.ShellKit HPS.ShellKit.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 ShellKit at which to start removing texture parameters.
in_countThe number of texture parameters to remove for this ShellKit.
Returns
A reference to this ShellKit.
HPS.ShellKit HPS.ShellKit.UnsetVertexVisibilities ( )
inline

Removes all vertex visibilities.

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

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