The ShellKey class is a smart pointer to a database object. It is a handle to a shell created by SegmentKey.InsertShell. More...

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) |
Completely replaces all settings on this ShellKey with those set on the specified kit and resets the kit. More... | |
override void | Dispose () |
HPS.ShellKey | EditFacelistByDeletion (ulong in_offset, ulong in_count) |
Removes faces from the face list for this ShellKey. This will not affect the points referenced by the removed faces, however any face attributes on the removed faces will be lost. More... | |
HPS.ShellKey | EditFacelistByInsertion (ulong in_offset, int[] in_facelist) |
Adds faces to the face list for this ShellKey. More... | |
HPS.ShellKey | EditFacelistByReplacement (ulong in_offset, int[] in_facelist) |
Replaces faces in the face list for this ShellKey. More... | |
HPS.ShellKey | EditPointsByDeletion (ulong in_offset, ulong in_count) |
Removes points from the point list for this ShellKey. Any existing faces which reference points which are being deleted will be removed. Additionally, any vertex settings 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.ShellKey | EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points) |
Adds points to the point list for this ShellKey. 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.ShellKey | EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points) |
Replaces points in the point list for this ShellKey. These points will replace those already referenced by any faces and will inherit any attributes the points being replaced had. More... | |
ulong | GetFaceCount () |
Retrieves the number of faces in this shell. Note that this is different than the length of the face list More... | |
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) |
Replace those settings on this ShellKey with those set on the specified kit. More... | |
HPS.ShellKey | 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.ShellKey | SetFaceIndexColorsByList (ulong[] in_faces, float in_index) |
Sets a single material index on a selection of arbitrary faces. More... | |
HPS.ShellKey | SetFaceIndexColorsByRange (ulong in_start, float[] in_indices) |
Sets face material indices on a range of faces starting at the specified offset. More... | |
HPS.ShellKey | 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.ShellKey | SetFacelist (int[] in_facelist) |
Replace the face list on this ShellKey with the specified face list. More... | |
HPS.ShellKey | 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.ShellKey | SetFaceNormalsByList (ulong[] in_faces, HPS.Vector in_normal) |
Sets a single normal on a selection of arbitrary faces. More... | |
HPS.ShellKey | SetFaceNormalsByRange (ulong in_start, HPS.Vector[] in_normals) |
Sets face normals on a range of faces starting at the specified offset. More... | |
HPS.ShellKey | 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.ShellKey | 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.ShellKey | SetFaceRGBColorsByList (ulong[] in_faces, HPS.RGBColor in_rgb_color) |
Sets a single RGB color on a selection of arbitrary faces. More... | |
HPS.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | SetFaceVisibilitiesByList (ulong[] in_faces, bool in_visibility) |
Sets a single visibility on a selection of arbitrary faces. More... | |
HPS.ShellKey | SetFaceVisibilitiesByRange (ulong in_start, bool[] in_visibilities) |
Sets face visibilities on a range of faces starting at the specified offset. More... | |
HPS.ShellKey | 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.ShellKey | SetMaterialMapping (HPS.MaterialMappingKit in_kit) |
Sets the specified material mappings on this ShellKey. Only face, back face, cut edge, cut face, edge, and vertex materials will be set on the 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.ShellKey | SetPoints (HPS.Point[] in_points) |
Replace the points on this ShellKey with the specified points. More... | |
HPS.ShellKey | SetTristrips (int[] in_tristrips) |
Replace the face list on this ShellKey with the specified face list. More... | |
HPS.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | SetVertexNormalsByList (ulong[] in_vertices, HPS.Vector in_normal) |
Sets a single normal on a selection of arbitrary vertices. More... | |
HPS.ShellKey | SetVertexNormalsByRange (ulong in_start, HPS.Vector[] in_normals) |
Sets vertex normals on a range of vertices starting at the specified offset. More... | |
HPS.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | SetVertexParametersByRange (ulong in_start, float[] in_params) |
Sets texture parameters on a range of vertices starting at the specified offset. More... | |
HPS.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | SetVertexVisibilitiesByList (ulong[] in_vertices, bool in_visibility) |
Sets a single visibility on a selection of arbitrary vertices. More... | |
HPS.ShellKey | SetVertexVisibilitiesByRange (ulong in_start, bool[] in_visibilities) |
Sets vertex visibilities on a range of vertices starting at the specified offset. More... | |
HPS.ShellKey | 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... | |
ShellKey () | |
The default constructor creates an uninitialized ShellKey object. The Type() function will return Type.None. More... | |
ShellKey (HPS.Key in_that) | |
This constructor creates an ShellKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a shell key. Otherwise the copy will fail and the resulting ShellKey will be invalid. More... | |
ShellKey (HPS.ShellKey in_that) | |
The copy constructor creates a ShellKey object that shares the underlying smart-pointer of the source ShellKey. More... | |
void | Show (out HPS.ShellKit out_kit) |
Copy the contents of this ShellKey into the specified kit. More... | |
bool | ShowFaceColors (out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices) |
Shows the face colors on ShellKey. 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 ShellKey. More... | |
bool | ShowFaceNormals (out bool[] out_validities, out HPS.Vector[] out_normals) |
Shows all the face normals for this ShellKey. 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 ShellKey. 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 ShellKey. These are the "global" material settings, not the per-vertex and per-face material settings. More... | |
bool | ShowNetFaceNormalsByList (ulong[] in_faces, out HPS.Vector[] out_normals) |
Shows the effective face normals on a selection of arbitrary faces. If a normal for a given face is unspecified, this will retrieve the effective normal. 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 | ShowNetFaceNormalsByRange (ulong in_start, ulong in_count, out HPS.Vector[] out_normals) |
Shows the effective face normals on a range of faces starting at the specified offset. If a normal for a given face is unspecified, this will retrieve the effective normal. More... | |
bool | ShowNetVertexNormals (out HPS.Vector[] out_normals) |
Shows the all net vertex normals on this ShellKey. More... | |
bool | ShowNetVertexNormalsByRange (ulong in_start, ulong in_count, out HPS.Vector[] out_normals) |
Shows the net vertex normals on a range of vertices starting at the specified offset. More... | |
bool | ShowPoints (out HPS.Point[] out_points) |
Show the points for this ShellKey. More... | |
bool | ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points) |
Show a subset of the points for this ShellKey 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 ShellKey by range. More... | |
bool | ShowTristrips (out int[] out_tristrips) |
Show the tristrips list for this ShellKey. More... | |
bool | ShowTristrips (out int[] out_tristrips, out int[] out_face_indices) |
Show the tristrips list for this ShellKey. 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 ShellKey. More... | |
bool | ShowVertexNormalsByList (ulong[] in_vertices, out bool[] out_validities, out HPS.Vector[] out_normals) |
Shows the vertex normals on a selection of arbitrary vertices. The order of the values in the output arrays is the same as the input vertex index array, i.e., the values of out_validities[i] and out_normals[i] correspond to the vertex at index in_vertices[i]. More... | |
bool | ShowVertexNormalsByRange (ulong in_start, ulong in_count, out bool[] out_validities, out HPS.Vector[] out_normals) |
Shows the vertex normals on a range of vertices starting at the specified offset. More... | |
bool | ShowVertexParameters (out bool[] out_validities, out float[] out_params) |
Shows the texture parameters for all of the vertices on this ShellKey. For this particular show function, the parameter width is returned implicitly and could be determined by out_params.size()/in_count. More... | |
bool | ShowVertexParameters (out bool[] out_validities, out float[] out_params, out ulong out_param_width) |
Shows the texture parameters for all of the vertices on this ShellKey. 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 ShellKey. 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.ShellKey | UnsetEverything () |
Removes all settings from this ShellKey. More... | |
HPS.ShellKey | UnsetFaceColors () |
Removes all face colors (RGB colors or material indices). More... | |
HPS.ShellKey | UnsetFaceColorsByList (ulong[] in_vertices) |
Removes the face colors (RGB colors or material indices) on a selection of arbitrary vertices. More... | |
HPS.ShellKey | 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.ShellKey | UnsetFaceEverything () |
Removes all face settings (face colors, face normals, and face visibilities) from this ShellKey. More... | |
HPS.ShellKey | UnsetFacelist () |
Removes the face list for this ShellKey. More... | |
HPS.ShellKey | UnsetFaceNormals () |
Removes all face normals. More... | |
HPS.ShellKey | UnsetFaceNormalsByList (ulong[] in_vertices) |
Removes the face normals on a selection of arbitrary faces. More... | |
HPS.ShellKey | UnsetFaceNormalsByRange (ulong in_start, ulong in_count) |
Removes the specified range of face normals starting at the specified offset. More... | |
HPS.ShellKey | UnsetFaceVisibilities () |
Removes all face visibilities. More... | |
HPS.ShellKey | UnsetFaceVisibilitiesByList (ulong[] in_vertices) |
Removes the face visibilities on a selection of arbitrary faces. More... | |
HPS.ShellKey | UnsetFaceVisibilitiesByRange (ulong in_start, ulong in_count) |
Removes the specified range of face visibilities starting at the specified offset. More... | |
HPS.ShellKey | UnsetMaterialMapping () |
Removes all material mappings on this ShellKey. This removes the "global" material settings and does not affect per-vertex or per-face materials. More... | |
HPS.ShellKey | UnsetPoints () |
Removes the points for this ShellKey. More... | |
HPS.ShellKey | UnsetTristrips () |
Removes the tristrips list for this ShellKey. More... | |
HPS.ShellKey | UnsetVertexColors () |
Removes all vertex colors (RGB colors, RGBA colors, or material indices) for all shell components. More... | |
HPS.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | 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.ShellKey | UnsetVertexEverything () |
Removes all vertex settings (vertex colors, vertex normals, texture parameters, and vertex visibilities) from this ShellKey. More... | |
HPS.ShellKey | UnsetVertexNormals () |
Removes all vertex normals. More... | |
HPS.ShellKey | UnsetVertexNormalsByList (ulong[] in_vertices) |
Removes the vertex normals on a selection of arbitrary vertices. More... | |
HPS.ShellKey | UnsetVertexNormalsByRange (ulong in_start, ulong in_count) |
Removes the specified range of vertex normals starting at the specified offset. More... | |
HPS.ShellKey | UnsetVertexParameters () |
Removes all texture parameters. More... | |
HPS.ShellKey | UnsetVertexParametersByList (ulong[] in_vertices) |
Removes the texture parameters on a selection of arbitrary vertices. More... | |
HPS.ShellKey | UnsetVertexParametersByRange (ulong in_start, ulong in_count) |
Removes the specified range of texture parameters starting at the specified offset. More... | |
HPS.ShellKey | UnsetVertexVisibilities () |
Removes all vertex visibilities. More... | |
HPS.ShellKey | UnsetVertexVisibilitiesByList (ulong[] in_vertices) |
Removes the vertex visibilities on a selection of arbitrary vertices. More... | |
HPS.ShellKey | UnsetVertexVisibilitiesByRange (ulong in_start, ulong in_count) |
Removes the specified range of vertex visibilities starting at the specified offset. More... | |
![]() | |
GeometryKey () | |
The default constructor creates an uninitialized GeometryKey object. The Type() function will return Type.None. More... | |
GeometryKey (HPS.Key in_that) | |
This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really a type of geometry key. Otherwise the copy will fail and the resulting GeometryKey will be invalid. More... | |
GeometryKey (HPS.GeometryKey in_that) | |
The copy constructor creates a GeometryKey object that shares the underlying smart-pointer of the source GeometryKey. More... | |
HPS.GeometryKey | SetPriority (int in_priority) |
Assigns a drawing priority value to the geometry. It affects the order in which the geometry is visited if and only if the rendering algorithm is set to Priority. The geometry has a default drawing priority assigned, based on the order of insertion. More... | |
HPS.GeometryKey | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this key. More... | |
HPS.GeometryKey | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this key. More... | |
HPS.GeometryKey | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this key. More... | |
bool | ShowBounding (out HPS.BoundingKit out_kit) |
Shows the bounding of this geometry. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
ulong | ShowReferrers (out HPS.SegmentKey[] out_segments) |
Shows the all the segments which contain references to this key. Note that while a segment may only appear once in the returned array, that segment could have multiple references to this key. More... | |
ulong | ShowReferrers (out HPS.ReferenceKey[] out_references) |
Shows the all the references to this key. More... | |
bool | ShowUserData (IntPtr in_index, out byte[] out_data) |
Shows the user data at a given index for this key. More... | |
bool | ShowUserData (out IntPtr[] out_indices, out byte[][] out_data) |
Shows all user data for this key. More... | |
ulong | ShowUserDataCount () |
Get the number of user data indices set on this key. More... | |
bool | ShowUserDataIndices (out IntPtr[] out_indices) |
Shows the indices of all user data set on this key. More... | |
HPS.GeometryKey | UnsetAllUserData () |
Removes all user data from this key. More... | |
HPS.GeometryKey | UnsetPriority () |
Removes the drawing priority setting. More... | |
HPS.GeometryKey | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this key. More... | |
HPS.GeometryKey | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this key. More... | |
![]() | |
virtual void | Assign (HPS.Key in_that) |
Share the underlying smart-pointer of the Key source. More... | |
HPS.Key | CopyTo (HPS.SegmentKey in_destination) |
Copies the database object referred to by this key into a segment pointed to by in_destination. More... | |
void | Delete () |
Removes the database object referred to by this key. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Key in_that) |
Determines whether the database objects pointed to by this key and in_that are the same. Empty keys (when key.Empty() returns true) are never equal to any key, even when the key is compared against itself (they act analogously to NaN comparisons in this case.) More... | |
ulong | GetHash () |
Returns a hash code for the key. More... | |
override int | GetHashCode () |
bool | HasOwner () |
| |
Key () | |
An uninitialized key refers to no database object and Type() will return Type.None. More... | |
Key (HPS.Key in_that) | |
Shares a reference to a database object referred to by in_that. More... | |
Key (HPS.Control in_control) | |
Initializes a key tied to the Control in_control. More... | |
void | MoveTo (HPS.SegmentKey in_new_owner) |
Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. More... | |
HPS.SegmentKey | Owner () |
| |
HPS.SegmentKey | Up () |
| |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Key a, HPS.Key b) |
static bool | operator== (HPS.Key a, HPS.Key b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The ShellKey class is a smart pointer to a database object. It is a handle to a shell created by SegmentKey.InsertShell.
Constructor & Destructor Documentation
|
inline |
|
inline |
|
inline |
Member Function Documentation
|
inline |
Computes the relation of a collection of points to this shell, subject to the specified options.
- Parameters
-
in_points An array of points to test against this shell. in_options The options to use when performing the relation test. out_results The results of the relation test.
|
inline |
Computes the relation of a collection of points to this shell, subject to the specified options.
- Parameters
-
in_points_source A shell whose points should be tested against this shell. in_options The options to use when performing the relation test. out_results The results of the relation test.
|
inline |
Computes the relation of a collection of points to this shell, subject to the specified options.
- Parameters
-
in_points_source A shell whose points should be tested against this shell. in_options The options to use when performing the relation test. out_results The results of the relation test.
|
inline |
|
inline |
Removes faces from the face list for this ShellKey. This will not affect the points referenced by the removed faces, however any face attributes on the removed faces will be lost.
- Parameters
-
in_offset The 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_count The 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 ShellKey.
|
inline |
Adds faces to the face list for this ShellKey.
- Parameters
-
in_offset The 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_facelist The faces (using the standard face-list encoding) to insert into the face list at the specified offset.
- Returns
- A reference to this ShellKey.
|
inline |
Replaces faces in the face list for this ShellKey.
- Parameters
-
in_offset The 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_facelist The 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 ShellKey.
|
inline |
Removes points from the point list for this ShellKey. Any existing faces which reference points which are being deleted will be removed. Additionally, any vertex settings 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_offset The 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_count The 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 ShellKey.
|
inline |
Adds points to the point list for this ShellKey. 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_offset The 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_points The points to insert into the point list at the specified offset.
- Returns
- A reference to this ShellKey.
|
inline |
Replaces points in the point list for this ShellKey. These points will replace those already referenced by any faces and will inherit any attributes the points being replaced had.
- Parameters
-
in_offset The 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_points The 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 ShellKey.
|
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.
|
inline |
Retrieves the number of points in this shell.
- Returns
- The number of points in this shell.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.GeometryKey.
|
inline |
Optimizes the shell using the parameters set in a ShellOptimizationOptionsKit
|
inline |
|
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_faces The indices of the faces on which to set the colors. Each index in the array must be such that in_faces[i]<face_count for setting to succeed. in_indices The material indices to set on the faces.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single material index on a selection of arbitrary faces.
- Parameters
-
in_faces The indices of the faces on which to set the color. Each index in the array must be such that in_faces[i]<face_count for setting to succeed. in_index The material index to set on the faces.
- Returns
- A reference to this ShellKey.
|
inline |
Sets face material indices on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed. in_indices The material indices to set on the faces for this ShellKey. The size of the array must be such that in_start+in_indices.size()<=face_count for the setting to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single material index on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start setting the color. This value must be such that in_start<face_count for setting to succeed. in_count The number of faces on which to set the color. This value must be such that in_start+in_count<=face_count for the setting to succeed. in_index The material index to set on the faces for this ShellKey.
- Returns
- A reference to this ShellKey.
|
inline |
|
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_faces The indices of the faces on which to set the normals. Each index in the array must be such that in_faces[i]<face_count for setting to succeed. in_normals The normals to set on the faces.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single normal on a selection of arbitrary faces.
- Parameters
-
in_faces The indices of the faces on which to set the normal. Each index in the array must be such that in_faces[i]<face_count for setting to succeed. in_normal The normal to set on the faces.
- Returns
- A reference to this ShellKey.
|
inline |
Sets face normals on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start setting normals. This value must be such that in_start<face_count for setting to succeed. in_normals The normals to set on the faces for this ShellKey. The size of the array must be such that in_start+in_normals.size()<=face_count for the setting to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single normal on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start setting the normal. This value must be such that in_start<face_count for setting to succeed. in_count The number of faces on which to set the normal. This value must be such that in_start+in_count<=face_count for the setting to succeed. in_normal The normal to set on the faces for this ShellKey.
- Returns
- A reference to this ShellKey.
|
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_faces The indices of the faces on which to set the colors. Each index in the array must be such that in_faces[i]<face_count for setting to succeed. in_rgb_colors The RGB colors to set on the faces.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single RGB color on a selection of arbitrary faces.
- Parameters
-
in_faces The indices of the faces on which to set the color. Each index in the array must be such that in_faces[i]<face_count for setting to succeed. in_rgb_color The RGB color to set on the faces.
- Returns
- A reference to this ShellKey.
|
inline |
Sets face RGB colors on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed. in_rgb_colors The RGB colors to set on the faces for this ShellKey. The size of the array must be such that in_start+in_rgb_colors.size()<=face_count for the setting to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single RGB color on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start setting the color. This value must be such that in_start<face_count for setting to succeed. in_count The number of faces on which to set the color. This value must be such that in_start+in_count<=face_count for the setting to succeed. in_rgb_color The RGB color to set on the faces for this ShellKey.
- Returns
- A reference to this ShellKey.
|
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_faces The indices of the faces on which to set the visibilities. Each index in the array must be such that in_faces[i]<face_count for setting to succeed. in_visibilities The visibilities to set on the faces.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single visibility on a selection of arbitrary faces.
- Parameters
-
in_faces The indices of the faces on which to set the visibility. Each index in the array must be such that in_faces[i]<face_count for setting to succeed. in_visibility The visibility to set on the faces.
- Returns
- A reference to this ShellKey.
|
inline |
Sets face visibilities on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start setting visibilities. This value must be such that in_start<face_count for setting to succeed. in_visibilities The visibilities to set on the faces for this ShellKey. The size of the array must be such that in_start+in_visibilities.size()<=face_count for the setting to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single visibility on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start setting the visibility. This value must be such that in_start<face_count for setting to succeed. in_count The number of faces on which to set the visibility. This value must be such that in_start+in_count<=face_count for the setting to succeed. in_visibility The visibility to set on the faces for this ShellKey.
- Returns
- A reference to this ShellKey.
|
inline |
Sets the specified material mappings on this ShellKey. Only face, back face, cut edge, cut face, edge, and vertex materials will be set on the 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_kit The material mappings to set on this ShellKey.
- Returns
- A reference to this ShellKey.
|
inline |
|
inline |
|
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_vertices The indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_indices The material indices to set on the vertices. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKey.
|
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_vertices The indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_indices The material indices to set on the vertices.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single material index on a selection of arbitrary vertices which apply to the specified shell component.
- Parameters
-
in_vertices The indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_index The material index to set on the vertices. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single material index on a selection of arbitrary vertices which apply to the specified shell component.
- Parameters
-
in_vertices The indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_index The material index to set on the vertices.
- Returns
- A reference to this ShellKey.
|
inline |
Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed. in_indices The material indices to set on the vertices for this ShellKey. The size of the array must be such that in_start+in_indices.size()<=point_count for the setting to succeed. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKey.
|
inline |
Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed. in_indices The material indices to set on the vertices for this ShellKey. The size of the array must be such that in_start+in_indices.size()<=point_count for the setting to succeed.
- Returns
- A reference to this ShellKey.
|
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_start The offset into the vertices for this ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed. in_count The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed. in_index The material index to set on the vertices for this ShellKey. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKey.
|
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_start The offset into the vertices for this ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed. in_count The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed. in_index The material index to set on the vertices for this ShellKey.
- Returns
- A reference to this ShellKey.
|
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_vertices The indices of the vertices on which to set the normals. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_normals The normals to set on the vertices.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single normal on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to set the normal. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_normal The normal to set on the vertices.
- Returns
- A reference to this ShellKey.
|
inline |
Sets vertex normals on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start setting normals. This value must be such that in_start<point_count for setting to succeed. in_normals The normals to set on the vertices for this ShellKey. The size of the array must be such that in_start+in_normals.size()<=point_count for the setting to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single normal on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start setting the normal. This value must be such that in_start<point_count for setting to succeed. in_count The number of vertices on which to set the normal. This value must be such that in_start+in_count<=point_count for the setting to succeed. in_normal The normal to set on the vertices for this ShellKey.
- Returns
- A reference to this ShellKey.
|
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_vertices The indices of the vertices on which to set the texture parameters. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_params The texture parameters to set on the vertices for this ShellKey. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored. in_param_width The number of texture parameters per vertex. Defaults to 2.
- Returns
- A reference to this ShellKey.
|
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_vertices The indices of the vertices on which to set the texture parameters. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_params The texture parameters to set on the vertices for this ShellKey. 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 ShellKey.
|
inline |
Sets texture parameters on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start setting texture parameters. This value must be such that in_start<point_count for setting to succeed. in_params The texture parameters to set on the vertices for this ShellKey. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored. The size of the array must be such that in_start+in_params.size()/in_param_width<=point_count for the setting to succeed. in_param_width The number of texture parameters per vertex. Defaults to 2.
- Returns
- A reference to this ShellKey.
|
inline |
Sets texture parameters on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start setting texture parameters. This value must be such that in_start<point_count for setting to succeed. in_params The texture parameters to set on the vertices for this ShellKey. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored. The size of the array must be such that in_start+in_params.size()/in_param_width<=point_count for the setting to succeed.
- Returns
- A reference to this ShellKey.
|
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_vertices The indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_rgba_colors The RGBA colors to set on the vertices. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKey.
|
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_vertices The indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_rgba_colors The RGBA colors to set on the vertices.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single RGBA color on a selection of arbitrary vertices which apply to the specified shell component.
- Parameters
-
in_vertices The indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_rgba_color The RGBA color to set on the vertices. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single RGBA color on a selection of arbitrary vertices which apply to the specified shell component.
- Parameters
-
in_vertices The indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_rgba_color The RGBA color to set on the vertices.
- Returns
- A reference to this ShellKey.
|
inline |
Sets vertex RGBA colors on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed. in_rgba_colors The RGBA colors to set on the vertices for this ShellKey. The size of the array must be such that in_start+in_rgba_colors.size()<=point_count for the setting to succeed. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKey.
|
inline |
Sets vertex RGBA colors on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed. in_rgba_colors The RGBA colors to set on the vertices for this ShellKey. The size of the array must be such that in_start+in_rgba_colors.size()<=point_count for the setting to succeed.
- Returns
- A reference to this ShellKey.
|
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_start The offset into the vertices for this ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed. in_count The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed. in_rgba_color The RGBA color to set on the vertices for this ShellKey. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKey.
|
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_start The offset into the vertices for this ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed. in_count The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed. in_rgba_color The RGBA color to set on the vertices for this ShellKey.
- Returns
- A reference to this ShellKey.
|
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_vertices The indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_rgb_colors The RGB colors to set on the vertices. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKey.
|
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_vertices The indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_rgb_colors The RGB colors to set on the vertices.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single RGB color on a selection of arbitrary vertices which apply to the specified shell component.
- Parameters
-
in_vertices The indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_rgb_color The RGB color to set on the vertices. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single RGB color on a selection of arbitrary vertices which apply to the specified shell component.
- Parameters
-
in_vertices The indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_rgb_color The RGB color to set on the vertices.
- Returns
- A reference to this ShellKey.
|
inline |
Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed. in_rgb_colors The RGB colors to set on the vertices for this ShellKey. The size of the array must be such that in_start+in_rgb_colors.size()<=point_count for the setting to succeed. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKey.
|
inline |
Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed. in_rgb_colors The RGB colors to set on the vertices for this ShellKey. The size of the array must be such that in_start+in_rgb_colors.size()<=point_count for the setting to succeed.
- Returns
- A reference to this ShellKey.
|
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_start The offset into the vertices for this ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed. in_count The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed. in_rgb_color The RGB color to set on the vertices for this ShellKey. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKey.
|
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_start The offset into the vertices for this ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed. in_count The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed. in_rgb_color The RGB color to set on the vertices for this ShellKey.
- Returns
- A reference to this ShellKey.
|
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_vertices The indices of the vertices on which to set the visibilities. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_visibilities The visibilities to set on the vertices.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single visibility on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to set the visibility. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_visibility The visibility to set on the vertices.
- Returns
- A reference to this ShellKey.
|
inline |
Sets vertex visibilities on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start setting visibilities. This value must be such that in_start<point_count for setting to succeed. in_visibilities The visibilities to set on the vertices for this ShellKey. The size of the array must be such that in_start+in_visibilities.size()<=point_count for the setting to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
Sets a single visibility on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start setting the visibility. This value must be such that in_start<point_count for setting to succeed. in_count The number of vertices on which to set the visibility. This value must be such that in_start+in_count<=point_count for the setting to succeed. in_visibility The visibility to set on the vertices for this ShellKey.
- Returns
- A reference to this ShellKey.
|
inline |
|
inline |
Shows the face colors on ShellKey.
- Parameters
-
out_types The types of face colors for each face. If a face does not have a face color set, the entry in this array will be Material.Type.None. out_rgb_colors The RGB colors for each face. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor. out_indices The material indices for each face. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
- Returns
- true if any face had a face color set, false otherwise.
|
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_faces The indices of the faces on which to show the colors. Each index in the array must be such that in_faces[i]<face_count for showing to succeed. out_types The types of face colors for each face at the specified index. If a face at a specified index does not have a face color set, the entry in this array will be Material.Type.None. out_rgb_colors The RGB colors for each face at the specified index. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor. out_indices The material indices for each face at the specified index. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
- Returns
- true if any specified face had a face color set, false otherwise.
|
inline |
Shows the face colors on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start showing colors. This value must be such that in_start<face_count for showing to succeed. in_count The number of colors to show. This value must be such that in_start+in_count<=face_count for the showing to succeed. out_types The types of face colors for each face in the specified range. If a face in the specified range does not have a face color set, the entry in this array will be Material.Type.None. out_rgb_colors The RGB colors for each face in the specified range. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor. out_indices The material indices for each face in the specified range. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
- Returns
- true if any face in the specified range had a face color set, false otherwise.
|
inline |
|
inline |
Shows all the face normals for this ShellKey.
- Parameters
-
out_validities The validities of the normals for each face. If a face had a normal set on it, the entry in this array will be true, otherwise it will be false. out_normals The face normals for each face. out_normals[i] is only valid if out_validities[i] is true.
- Returns
- true if any face had a face normal set, false otherwise.
|
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_faces The indices of the faces on which to show the normals. Each index in the array must be such that in_faces[i]<face_count for showing to succeed. out_validities The validities of the normals for each face at the specified index. If a face at a specified index had a normal set on it, the entry in this array will be true, otherwise it will be false. out_normals The face normals for each face at the specified index. out_normals[i] is only valid if out_validities[i] is true.
- Returns
- true if any specified face had a face normal set, false otherwise.
|
inline |
Shows the face normals on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start showing normals. This value must be such that in_start<face_count for showing to succeed. in_count The number of normals to show. This value must be such that in_start+in_count<=face_count for the showing to succeed. out_validities The validities of the normals for each face in the specified range. If a face in the specified range had a normal set on it, the entry in this array will be true, otherwise it will be false. out_normals The face normals for each face in the specified range. out_normals[i] is only valid if out_validities[i] is true.
- Returns
- true if any face in the specified range had a face normal set, false otherwise.
|
inline |
Shows all the face visibilities on this ShellKey.
- Parameters
-
out_validities The validities of the visibilities for each face. If a face had a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The face visibilities for each face. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any face had a face visibility set, false otherwise.
|
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_faces The indices of the faces on which to show the normals. Each index in the array must be such that in_faces[i]<face_count for showing to succeed. out_validities The validities of the normals for each face at the specified index. If a face at a specified index had a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The face visibilities for each face at the specified index. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any specified face had a face visibility set, false otherwise.
|
inline |
Shows the face visibilities on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start showing visibilities. This value must be such that in_start<face_count for showing to succeed. in_count The number of visibilities to show. This value must be such that in_start+in_count<=face_count for the showing to succeed. out_validities The validities of the visibilities for each face in the specified range. If a face in the specified range had a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The face visibilities for each face in the specified range. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any face in the specified range had a face visibility set, false otherwise.
|
inline |
|
inline |
Shows the effective face normals on a selection of arbitrary faces. If a normal for a given face is unspecified, this will retrieve the effective normal. The order of the values in the output arrays is the same as the input face index array, i.e., the values of out_validities[i] and out_normals[i] correspond to the face at index in_faces[i].
- Parameters
-
in_faces The indices of the faces on which to show the normals. Each index in the array must be such that in_faces[i]<face_count for showing to succeed. out_normals The face normals for each face at the specified index.
- Returns
- true if no errors were encountered, false otherwise.
|
inline |
Shows the effective face normals on a range of faces starting at the specified offset. If a normal for a given face is unspecified, this will retrieve the effective normal.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start showing normals. This value must be such that in_start<face_count for showing to succeed. in_count The number of normals to show. This value must be such that in_start+in_count<=face_count for the showing to succeed. out_normals The face normals for each face in the specified range.
- Returns
- true if no errors were encountered, false otherwise.
|
inline |
Shows the all net vertex normals on this ShellKey.
- Parameters
-
out_normals The vertex normals for each vertex.
- Returns
- true if no errors were encountered, false otherwise.
|
inline |
Shows the net vertex normals on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start showing normals. This value must be such that in_start<point_count for showing to succeed. in_count The number of normals to show. This value must be such that in_start+in_count<=point_count for the showing to succeed. out_normals The vertex normals for each vertex in the specified range.
- Returns
- true if no errors were encountered, false otherwise.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Shows all the vertex colors on the specified shell component.
- Parameters
-
in_apply_to The shell component the colors should apply to. out_types The types of vertex colors for each vertex. If a vertex does not have a vertex color set for the specified shell component, the entry in this array will be Material.Type.None. out_rgb_colors The RGB colors for each vertex. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor. out_rgba_colors The RGBA colors for each vertex. out_rgba_colors[i] is only valid if out_types[i] is Material.Type.RGBAColor. out_indices The material indices for each vertex. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
- Returns
- true if any vertex colors were shown, false otherwise.
|
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_vertices The indices of the vertices on which to show the colors. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed. in_apply_to The shell component the colors should apply to. out_types The types of vertex colors for each vertex at the specified index. If a vertex at a specified index does not have a vertex color set for the specified component, the entry in this array will be Material.Type.None. out_rgb_colors The RGB colors for each vertex at the specified index. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor. out_rgba_colors The RGBA colors for each vertex at the specified index. out_rgba_colors[i] is only valid if out_types[i] is Material.Type.RGBAColor. out_indices The material indices for each vertex at the specified index. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
- Returns
- true if any specified vertex had a vertex color on the specified component set, false otherwise.
|
inline |
Shows the vertex colors on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start showing colors. This value must be such that in_start<point_count for showing to succeed. in_count The number of colors to show. This value must be such that in_start+in_count<=point_count for the showing to succeed. in_apply_to The shell component the colors should apply to. out_types The types of vertex colors for each vertex in the specified range. If a vertex in the specified range does not have a vertex color set for the specified shell component, the entry in this array will be Material.Type.None. out_rgb_colors The RGB colors for each vertex in the specified range. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor. out_rgba_colors The RGBA colors for each vertex in the specified range. out_rgba_colors[i] is only valid if out_types[i] is Material.Type.RGBAColor. out_indices The material indices for each vertex in the specified range. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
- Returns
- true if any vertex in the specified range had a vertex color on the specified component set, false otherwise.
|
inline |
Shows all the vertex normals on this ShellKey.
- Parameters
-
out_validities The validities of the normals for each vertex. If a vertex had a normal set on it, the entry in this array will be true, otherwise it will be false. out_normals The vertex normals for each vertex. out_normals[i] is only valid if out_validities[i] is true.
- Returns
- true if any vertex normals were shown, false otherwise.
|
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_vertices The indices of the vertices on which to show the normals. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed. out_validities The validities of the normals for each vertex at the specified index. If a vertex at a specified index had a normal set on it, the entry in this array will be true, otherwise it will be false. out_normals The vertex normals for each vertex at the specified index. out_normals[i] is only valid if out_validities[i] is true.
- Returns
- true if any specified vertex had a vertex normal set, false otherwise.
|
inline |
Shows the vertex normals on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start showing normals. This value must be such that in_start<point_count for showing to succeed. in_count The number of normals to show. This value must be such that in_start+in_count<=point_count for the showing to succeed. out_validities The validities of the normals for each vertex in the specified range. If a vertex in the specified range had a normal set on it, the entry in this array will be true, otherwise it will be false. out_normals The vertex normals for each vertex in the specified range. out_normals[i] is only valid if out_validities[i] is true.
- Returns
- true if any vertex in the specified range had a vertex normal set, false otherwise.
|
inline |
Shows the texture parameters for all of the vertices on this ShellKey. For this particular show function, the parameter width is returned implicitly and could be determined by out_params.size()/in_count.
- Parameters
-
out_validities The validities of the texture parameters for each vertex. If a vertex had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params The texture parameters for each vertex. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
- Returns
- true if any vertex had a texture parameter set, false otherwise.
|
inline |
Shows the texture parameters for all of the vertices on this ShellKey.
- Parameters
-
out_validities The validities of the texture parameters for each vertex. If a vertex had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params The texture parameters for each vertex. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true. out_param_width The number of texture parameters per vertex.
- Returns
- true if any vertex had a texture parameter set, false otherwise.
|
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_vertices The indices of the vertices on which to show the texture parameters. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed. out_validities The validities of the texture parameters for each vertex at the specified index. If a vertex at a specified index had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params The texture parameters for each vertex at the specified index. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
- Returns
- true if any specified vertex had a texture parameter set, false otherwise.
|
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_vertices The indices of the vertices on which to show the texture parameters. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed. out_validities The validities of the texture parameters for each vertex at the specified index. If a vertex at a specified index had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params The texture parameters for each vertex at the specified index. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true. out_param_width The number of texture parameters per vertex.
- Returns
- true if any specified vertex had a texture parameter set, false otherwise.
|
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_start The offset into the vertices for this ShellKey at which to start showing texture parameters. This value must be such that in_start<point_count for showing to succeed. in_count The number of vertices for which to show the texture parameters. This value must be such that in_start+in_count<=point_count for the showing to succeed. out_validities The validities of the texture parameters for each vertex in the specified range. If a vertex in the specified range had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params The texture parameters for each vertex in the specified range. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
- Returns
- true if any vertex in the specified range had a texture parameter set, false otherwise.
|
inline |
Shows the texture parameters on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start showing texture parameters. This value must be such that in_start<point_count for showing to succeed. in_count The number of vertices for which to show the texture parameters. This value must be such that in_start+in_count<=point_count for the showing to succeed. out_validities The validities of the texture parameters for each vertex in the specified range. If a vertex in the specified range had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params The texture parameters for each vertex in the specified range. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true. out_param_width The number of texture parameters per vertex.
- Returns
- true if any vertex in the specified range had a texture parameter set, false otherwise.
|
inline |
Shows all the vertex visibilities on this ShellKey.
- Parameters
-
out_validities The validities of the visibilities for each vertex. If a vertex had a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The vertex visibilities for each vertex. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any vertex had a vertex visibility set, false otherwise.
|
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_vertices The indices of the vertices on which to show the normals. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed. out_validities The validities of the normals for each vertex at the specified index. If a vertex at a specified index had a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The vertex visibilities for each vertex at the specified index. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any specified vertex had a vertex visibility set, false otherwise.
|
inline |
Shows the vertex visibilities on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start showing visibilities. This value must be such that in_start<point_count for showing to succeed. in_count The number of visibilities to show. This value must be such that in_start+in_count<=point_count for the showing to succeed. out_validities The validities of the visibilities for each vertex in the specified range. If a vertex in the specified range had a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The vertex visibilities for each vertex in the specified range. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any vertex in the specified range had a vertex visibility set, false otherwise.
|
inline |
|
inline |
Removes all face colors (RGB colors or material indices).
- Returns
- A reference to this ShellKey.
|
inline |
Removes the face colors (RGB colors or material indices) on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the faces on which to remove the colors. Each index in the array must be such that in_faces[i]<face_count for removal to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
Removes the specified range of face colors (RGB colors or material indices) starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start removing colors. This value must be such that in_start<face_count for removal to succeed. in_count The number of face colors to remove for this ShellKey. This value must be such that in_start+in_count<=face_count for the removal to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
|
inline |
|
inline |
Removes all face normals.
- Returns
- A reference to this ShellKey.
|
inline |
Removes the face normals on a selection of arbitrary faces.
- Returns
- A reference to this ShellKey.
|
inline |
Removes the specified range of face normals starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start removing normals. This value must be such that in_start<face_count for removal to succeed. in_count The number of face normals to remove for this ShellKey. This value must be such that in_start+in_count<=face_count for the removal to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
Removes all face visibilities.
- Returns
- A reference to this ShellKey.
|
inline |
Removes the face visibilities on a selection of arbitrary faces.
- Returns
- A reference to this ShellKey.
|
inline |
Removes the specified range of face visibilities starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKey at which to start removing visibilities. This value must be such that in_start<face_count for removal to succeed. in_count The number of face visibilities to remove for this ShellKey. This value must be such that in_start+in_count<=face_count for the removal to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
|
inline |
|
inline |
|
inline |
Removes all vertex colors (RGB colors, RGBA colors, or material indices) for all shell components.
- Returns
- A reference to this ShellKey.
|
inline |
Removes all vertex colors (RGB colors, RGBA colors, or material indices) for the specified shell component.
- Parameters
-
in_apply_to The shell component for which to remove the colors.
- Returns
- A reference to this ShellKey.
|
inline |
Removes the vertex colors (RGB colors, RGBA colors, or material indices) for all shell components on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to remove the colors. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.
- Returns
- A reference to this ShellKey.
|
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_vertices The indices of the vertices on which to remove the colors. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed. in_apply_to The shell component for which to remove the colors.
- Returns
- A reference to this ShellKey.
|
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_start The offset into the vertices for this ShellKey at which to start removing colors. This value must be such that in_start<point_count for removal to succeed. in_count The number of vertex colors to remove for this ShellKey. This value must be such that in_start+in_count<=point_count for the removal to succeed.
- Returns
- A reference to this ShellKey.
|
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_start The offset into the vertices for this ShellKey at which to start removing colors. This value must be such that in_start<point_count for removal to succeed. in_count The number of vertex colors to remove for this ShellKey. This value must be such that in_start+in_count<=point_count for the removal to succeed. in_apply_to The shell component for which to remove the colors.
- Returns
- A reference to this ShellKey.
|
inline |
|
inline |
Removes all vertex normals.
- Returns
- A reference to this ShellKey.
|
inline |
Removes the vertex normals on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to remove the normals. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
Removes the specified range of vertex normals starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start removing normals. This value must be such that in_start<point_count for removal to succeed. in_count The number of vertex normals to remove for this ShellKey. This value must be such that in_start+in_count<=point_count for the removal to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
Removes all texture parameters.
- Returns
- A reference to this ShellKey.
|
inline |
Removes the texture parameters on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to remove the texture parameters. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
Removes the specified range of texture parameters starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start removing texture parameters. This value must be such that in_start<point_count for removal to succeed. in_count The number of texture parameters to remove for this ShellKey. This value must be such that in_start+in_count<=point_count for the removal to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
Removes all vertex visibilities.
- Returns
- A reference to this ShellKey.
|
inline |
Removes the vertex visibilities on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to remove the visibilities. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.
- Returns
- A reference to this ShellKey.
|
inline |
Removes the specified range of vertex visibilities starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKey at which to start removing visibilities. This value must be such that in_start<point_count for removal to succeed. in_count The number of vertex visibilities to remove for this ShellKey. This value must be such that in_start+in_count<=point_count for the removal to succeed.
- Returns
- A reference to this ShellKey.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.ShellKey.cs