
Public Member Functions | |
void | ComputeRelation (HPS.Point[] in_points, HPS.ShellRelationOptionsKit in_options, out HPS.ShellRelationResultsKit out_results) |
void | ComputeRelation (HPS.ShellKey in_points_source, HPS.ShellRelationOptionsKit in_options, out HPS.ShellRelationResultsKit out_results) |
void | ComputeRelation (HPS.ShellKit in_points_source, HPS.ShellRelationOptionsKit in_options, out HPS.ShellRelationResultsKit out_results) |
void | Consume (HPS.ShellKit in_kit) |
override void | Dispose () |
HPS.ShellKit | EditFacelistByDeletion (ulong in_offset, ulong in_count) |
HPS.ShellKit | EditFacelistByInsertion (ulong in_offset, int[] in_facelist) |
HPS.ShellKit | EditFacelistByReplacement (ulong in_offset, int[] in_facelist) |
HPS.ShellKit | EditPointsByDeletion (ulong in_offset, ulong in_count) |
HPS.ShellKit | EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points) |
HPS.ShellKit | EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points) |
override bool | Empty () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.ShellKit in_kit) |
ulong | GetFaceCount () |
override int | GetHashCode () |
ulong | GetPointCount () |
override HPS.Type | ObjectType () |
void | Optimize (HPS.ShellOptimizationOptionsKit in_shell_optimization_kit) |
void | Set (HPS.ShellKit in_kit) |
HPS.ShellKit | SetEdgeIndexColorsByList (ulong[] in_vertices1, ulong[] in_vertices2, float[] in_indices) |
HPS.ShellKit | SetEdgeIndexColorsByList (ulong[] in_vertices1, ulong[] in_vertices2, float in_index) |
HPS.ShellKit | SetEdgeRGBColorsByList (ulong[] in_vertices1, ulong[] in_vertices2, HPS.RGBColor[] in_rgb_colors) |
HPS.ShellKit | SetEdgeRGBColorsByList (ulong[] in_vertices1, ulong[] in_vertices2, HPS.RGBColor in_rgb_color) |
HPS.ShellKit | SetEdgeVisibilitiesByList (ulong[] in_vertices1, ulong[] in_vertices2, bool[] in_visibilities) |
HPS.ShellKit | SetEdgeVisibilitiesByList (ulong[] in_vertices1, ulong[] in_vertices2, bool in_visibility) |
HPS.ShellKit | SetFaceIndexColorsByList (ulong[] in_faces, float[] in_indices) |
HPS.ShellKit | SetFaceIndexColorsByList (ulong[] in_faces, float in_index) |
HPS.ShellKit | SetFaceIndexColorsByRange (ulong in_start, float[] in_indices) |
HPS.ShellKit | SetFaceIndexColorsByRange (ulong in_start, ulong in_count, float in_index) |
HPS.ShellKit | SetFacelist (int[] in_facelist) |
HPS.ShellKit | SetFaceNormalsByList (ulong[] in_faces, HPS.Vector[] in_normals) |
HPS.ShellKit | SetFaceNormalsByList (ulong[] in_faces, HPS.Vector in_normal) |
HPS.ShellKit | SetFaceNormalsByRange (ulong in_start, HPS.Vector[] in_normals) |
HPS.ShellKit | SetFaceNormalsByRange (ulong in_start, ulong in_count, HPS.Vector in_normal) |
HPS.ShellKit | SetFaceRGBColorsByList (ulong[] in_faces, HPS.RGBColor[] in_rgb_colors) |
HPS.ShellKit | SetFaceRGBColorsByList (ulong[] in_faces, HPS.RGBColor in_rgb_color) |
HPS.ShellKit | SetFaceRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors) |
HPS.ShellKit | SetFaceRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color) |
HPS.ShellKit | SetFaceVisibilitiesByList (ulong[] in_faces, bool[] in_visibilities) |
HPS.ShellKit | SetFaceVisibilitiesByList (ulong[] in_faces, bool in_visibility) |
HPS.ShellKit | SetFaceVisibilitiesByRange (ulong in_start, bool[] in_visibilities) |
HPS.ShellKit | SetFaceVisibilitiesByRange (ulong in_start, ulong in_count, bool in_visibility) |
HPS.ShellKit | SetMaterialMapping (HPS.MaterialMappingKit in_kit) |
HPS.ShellKit | SetPoints (HPS.Point[] in_points) |
HPS.ShellKit | SetPriority (int in_priority) |
HPS.ShellKit | SetTristrips (int[] in_tristrips) |
HPS.ShellKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
HPS.ShellKit | SetUserData (IntPtr in_index, byte[] in_data) |
HPS.ShellKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
HPS.ShellKit | SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices, HPS.Shell.Component in_apply_to) |
HPS.ShellKit | SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices) |
HPS.ShellKit | SetVertexIndexColorsByList (ulong[] in_vertices, float in_index, HPS.Shell.Component in_apply_to) |
HPS.ShellKit | SetVertexIndexColorsByList (ulong[] in_vertices, float in_index) |
HPS.ShellKit | SetVertexIndexColorsByRange (ulong in_start, float[] in_indices, HPS.Shell.Component in_apply_to) |
HPS.ShellKit | SetVertexIndexColorsByRange (ulong in_start, float[] in_indices) |
HPS.ShellKit | SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index, HPS.Shell.Component in_apply_to) |
HPS.ShellKit | SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index) |
HPS.ShellKit | SetVertexNormalsByList (ulong[] in_vertices, HPS.Vector[] in_normals) |
HPS.ShellKit | SetVertexNormalsByList (ulong[] in_vertices, HPS.Vector in_normal) |
HPS.ShellKit | SetVertexNormalsByRange (ulong in_start, HPS.Vector[] in_normals) |
HPS.ShellKit | SetVertexNormalsByRange (ulong in_start, ulong in_count, HPS.Vector in_normal) |
HPS.ShellKit | SetVertexParametersByList (ulong[] in_vertices, float[] in_params, ulong in_param_width) |
HPS.ShellKit | SetVertexParametersByList (ulong[] in_vertices, float[] in_params) |
HPS.ShellKit | SetVertexParametersByRange (ulong in_start, float[] in_params, ulong in_param_width) |
HPS.ShellKit | SetVertexParametersByRange (ulong in_start, float[] in_params) |
HPS.ShellKit | SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor[] in_rgba_colors, HPS.Shell.Component in_apply_to) |
HPS.ShellKit | SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor[] in_rgba_colors) |
HPS.ShellKit | SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor in_rgba_color, HPS.Shell.Component in_apply_to) |
HPS.ShellKit | SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor in_rgba_color) |
HPS.ShellKit | SetVertexRGBAColorsByRange (ulong in_start, HPS.RGBAColor[] in_rgba_colors, HPS.Shell.Component in_apply_to) |
HPS.ShellKit | SetVertexRGBAColorsByRange (ulong in_start, HPS.RGBAColor[] in_rgba_colors) |
HPS.ShellKit | SetVertexRGBAColorsByRange (ulong in_start, ulong in_count, HPS.RGBAColor in_rgba_color, HPS.Shell.Component in_apply_to) |
HPS.ShellKit | SetVertexRGBAColorsByRange (ulong in_start, ulong in_count, HPS.RGBAColor in_rgba_color) |
HPS.ShellKit | SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors, HPS.Shell.Component in_apply_to) |
HPS.ShellKit | SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors) |
HPS.ShellKit | SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color, HPS.Shell.Component in_apply_to) |
HPS.ShellKit | SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color) |
HPS.ShellKit | SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors, HPS.Shell.Component in_apply_to) |
HPS.ShellKit | SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors) |
HPS.ShellKit | SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color, HPS.Shell.Component in_apply_to) |
HPS.ShellKit | SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color) |
HPS.ShellKit | SetVertexVisibilitiesByList (ulong[] in_vertices, bool[] in_visibilities) |
HPS.ShellKit | SetVertexVisibilitiesByList (ulong[] in_vertices, bool in_visibility) |
HPS.ShellKit | SetVertexVisibilitiesByRange (ulong in_start, bool[] in_visibilities) |
HPS.ShellKit | SetVertexVisibilitiesByRange (ulong in_start, ulong in_count, bool in_visibility) |
ShellKit () | |
ShellKit (HPS.ShellKit in_kit) | |
void | Show (out HPS.ShellKit out_kit) |
bool | ShowEdgeColors (out ulong[] out_vertices1, out ulong[] out_vertices2, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices) |
bool | ShowEdgeColorsByList (ulong[] in_vertices1, ulong[] in_vertices2, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices) |
bool | ShowEdgeVisibilitiesByList (ulong[] in_vertices1, ulong[] in_vertices2, out bool[] out_validities, out bool[] out_visibilities) |
bool | ShowFaceColors (out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices) |
bool | ShowFaceColorsByList (ulong[] in_faces, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices) |
bool | ShowFaceColorsByRange (ulong in_start, ulong in_count, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices) |
bool | ShowFacelist (out int[] out_facelist) |
bool | ShowFaceNormals (out bool[] out_validities, out HPS.Vector[] out_normals) |
bool | ShowFaceNormalsByList (ulong[] in_faces, out bool[] out_validities, out HPS.Vector[] out_normals) |
bool | ShowFaceNormalsByRange (ulong in_start, ulong in_count, out bool[] out_validities, out HPS.Vector[] out_normals) |
bool | ShowFaceVisibilities (out bool[] out_validities, out bool[] out_visibilities) |
bool | ShowFaceVisibilitiesByList (ulong[] in_faces, out bool[] out_validities, out bool[] out_visibilities) |
bool | ShowFaceVisibilitiesByRange (ulong in_start, ulong in_count, out bool[] out_validities, out bool[] out_visibilities) |
bool | ShowMaterialMapping (out HPS.MaterialMappingKit out_kit) |
bool | ShowPoints (out HPS.Point[] out_points) |
bool | ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points) |
bool | ShowPointsByRange (ulong in_start_index, ulong in_count, out HPS.Point[] out_points) |
bool | ShowPriority (out int out_priority) |
bool | ShowTristrips (out int[] out_tristrips) |
bool | ShowUserData (IntPtr in_index, out byte[] out_data) |
bool | ShowUserData (out IntPtr[] out_indices, out byte[][] out_data) |
ulong | ShowUserDataCount () |
bool | ShowUserDataIndices (out IntPtr[] out_indices) |
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) |
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) |
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) |
bool | ShowVertexNormals (out bool[] out_validities, out HPS.Vector[] out_normals) |
bool | ShowVertexNormalsByList (ulong[] in_vertices, out bool[] out_validities, out HPS.Vector[] out_normals) |
bool | ShowVertexNormalsByRange (ulong in_start, ulong in_count, out bool[] out_validities, out HPS.Vector[] out_normals) |
bool | ShowVertexParameters (out bool[] out_validities, out float[] out_params) |
bool | ShowVertexParameters (out bool[] out_validities, out float[] out_params, out ulong out_param_width) |
bool | ShowVertexParametersByList (ulong[] in_vertices, out bool[] out_validities, out float[] out_params) |
bool | ShowVertexParametersByList (ulong[] in_vertices, out bool[] out_validities, out float[] out_params, out ulong out_param_width) |
bool | ShowVertexParametersByRange (ulong in_start, ulong in_count, out bool[] out_validities, out float[] out_params) |
bool | ShowVertexParametersByRange (ulong in_start, ulong in_count, out bool[] out_validities, out float[] out_params, out ulong out_param_width) |
bool | ShowVertexVisibilities (out bool[] out_validities, out bool[] out_visibilities) |
bool | ShowVertexVisibilitiesByList (ulong[] in_vertices, out bool[] out_validities, out bool[] out_visibilities) |
bool | ShowVertexVisibilitiesByRange (ulong in_start, ulong in_count, out bool[] out_validities, out bool[] out_visibilities) |
HPS.ShellKit | UnsetAllUserData () |
HPS.ShellKit | UnsetEdgeColors () |
HPS.ShellKit | UnsetEdgeColorsByList (ulong[] in_vertices1, ulong[] in_vertices2) |
HPS.ShellKit | UnsetEdgeEverything () |
HPS.ShellKit | UnsetEdgeVisibilities () |
HPS.ShellKit | UnsetEdgeVisibilitiesByList (ulong[] in_vertices1, ulong[] in_vertices2) |
HPS.ShellKit | UnsetEverything () |
HPS.ShellKit | UnsetFaceColors () |
HPS.ShellKit | UnsetFaceColorsByList (ulong[] in_faces) |
HPS.ShellKit | UnsetFaceColorsByRange (ulong in_start, ulong in_count) |
HPS.ShellKit | UnsetFaceEverything () |
HPS.ShellKit | UnsetFacelist () |
HPS.ShellKit | UnsetFaceNormals () |
HPS.ShellKit | UnsetFaceNormalsByList (ulong[] in_vertices) |
HPS.ShellKit | UnsetFaceNormalsByRange (ulong in_start, ulong in_count) |
HPS.ShellKit | UnsetFaceVisibilities () |
HPS.ShellKit | UnsetFaceVisibilitiesByList (ulong[] in_faces) |
HPS.ShellKit | UnsetFaceVisibilitiesByRange (ulong in_start, ulong in_count) |
HPS.ShellKit | UnsetMaterialMapping () |
HPS.ShellKit | UnsetPoints () |
HPS.ShellKit | UnsetPriority () |
HPS.ShellKit | UnsetTristrips () |
HPS.ShellKit | UnsetUserData (IntPtr in_index) |
HPS.ShellKit | UnsetUserData (IntPtr[] in_indices) |
HPS.ShellKit | UnsetVertexColors () |
HPS.ShellKit | UnsetVertexColors (HPS.Shell.Component in_apply_to) |
HPS.ShellKit | UnsetVertexColorsByList (ulong[] in_vertices) |
HPS.ShellKit | UnsetVertexColorsByList (ulong[] in_vertices, HPS.Shell.Component in_apply_to) |
HPS.ShellKit | UnsetVertexColorsByRange (ulong in_start, ulong in_count) |
HPS.ShellKit | UnsetVertexColorsByRange (ulong in_start, ulong in_count, HPS.Shell.Component in_apply_to) |
HPS.ShellKit | UnsetVertexEverything () |
HPS.ShellKit | UnsetVertexNormals () |
HPS.ShellKit | UnsetVertexNormalsByList (ulong[] in_vertices) |
HPS.ShellKit | UnsetVertexNormalsByRange (ulong in_start, ulong in_count) |
HPS.ShellKit | UnsetVertexParameters () |
HPS.ShellKit | UnsetVertexParametersByList (ulong[] in_vertices) |
HPS.ShellKit | UnsetVertexParametersByRange (ulong in_start, ulong in_count) |
HPS.ShellKit | UnsetVertexVisibilities () |
HPS.ShellKit | UnsetVertexVisibilitiesByList (ulong[] in_vertices) |
HPS.ShellKit | UnsetVertexVisibilitiesByRange (ulong in_start, ulong in_count) |
![]() | |
Kit (HPS.Kit in_that) | |
override HPS.Type | Type () |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
bool | HasType (HPS.Type in_mask) |
Object (HPS.Object that) | |
virtual void | Reset () |
Static Public Member Functions | |
static bool | operator!= (HPS.ShellKit a, HPS.ShellKit b) |
static bool | operator== (HPS.ShellKit a, HPS.ShellKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
Constructor & Destructor Documentation
◆ ShellKit() [1/2]
|
inline |
The default constructor creates an empty ShellKit object.
◆ ShellKit() [2/2]
|
inline |
Member Function Documentation
◆ ComputeRelation() [1/3]
|
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.
◆ ComputeRelation() [2/3]
|
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.
◆ ComputeRelation() [3/3]
|
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.
◆ Consume()
|
inline |
◆ EditFacelistByDeletion()
|
inline |
Removes faces from the face list for this ShellKit. This will not affect the points referenced by the removed faces, however any face attributes on the removed faces will be lost.
- Parameters
-
in_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 ShellKit.
◆ EditFacelistByInsertion()
|
inline |
Adds faces to the face list for this ShellKit.
- 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 ShellKit.
◆ EditFacelistByReplacement()
|
inline |
Replaces faces in the face list for this ShellKit.
- 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 ShellKit.
◆ EditPointsByDeletion()
|
inline |
Removes points from the point list for this ShellKit. Any existing faces which reference points which are being deleted will be removed. Additionally, any vertex attributes on the deleted vertices, i.e., colors, normals, parameters, and visibilities, will be removed. The face list will also be updated to reflect the new vertex offsets caused by removing elements from the point list.
- Parameters
-
in_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 ShellKit.
◆ EditPointsByInsertion()
|
inline |
Adds points to the point list for this ShellKit. No existing faces will reference these points, i.e., the face list will be updated to reference the original vertices in their new positions. Addtionally, no vertex attributes will apply to these points, i.e., the vertex attributes will only be set on those points which had them prior to the insertion.
- Parameters
-
in_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 ShellKit.
◆ EditPointsByReplacement()
|
inline |
Replaces points in the point list for this ShellKit. These points will replace those already referenced by any faces and will inherit any attributes the points being replaced had.
- Parameters
-
in_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 ShellKit.
◆ Empty()
|
inlinevirtual |
Indicates whether this ShellKit has any values set on it.
- Returns
- true if no values are set on this ShellKit, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
|
inline |
◆ GetFaceCount()
|
inline |
Retrieves the number of faces in this shell. Note that this is different than the length of the face list
- Returns
- The number of faces in this shell.
◆ GetPointCount()
|
inline |
Retrieves the number of points in this shell.
- Returns
- The number of points in this shell.
◆ ObjectType()
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Kit.
◆ Optimize()
|
inline |
Optimizes the shell using the parameters set in a ShellOptimizationOptionsKit
◆ Set()
|
inline |
◆ SetEdgeIndexColorsByList() [1/2]
|
inline |
Sets edge material indices on a selection of arbitrary edges.
- Parameters
-
in_vertices1 The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_vertices2 The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_indices The material indices to set on the edges.
- Returns
- A reference to this ShellKit.
◆ SetEdgeIndexColorsByList() [2/2]
|
inline |
Sets edge material indices on a selection of arbitrary edges.
- Parameters
-
in_vertices1 The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_vertices2 The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_index The material index to set on the edges.
- Returns
- A reference to this ShellKit.
◆ SetEdgeRGBColorsByList() [1/2]
|
inline |
Sets edge colors on a selection of arbitrary edges.
- Parameters
-
in_vertices1 The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_vertices2 The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_rgb_colors The colors to set on the edges.
- Returns
- A reference to this ShellKit.
◆ SetEdgeRGBColorsByList() [2/2]
|
inline |
Sets edge colors on a selection of arbitrary edges.
- Parameters
-
in_vertices1 The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_vertices2 The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_rgb_color The color to set on the edges.
- Returns
- A reference to this ShellKit.
◆ SetEdgeVisibilitiesByList() [1/2]
|
inline |
Sets edge visibilities on a selection of arbitrary edges.
- Parameters
-
in_vertices1 The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_vertices2 The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_visibilities The visibilities that should be set for each edge specified.
- Returns
- A reference to this ShellKit.
◆ SetEdgeVisibilitiesByList() [2/2]
|
inline |
Sets edge visibilities on a selection of arbitrary edges.
- Parameters
-
in_vertices1 The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_vertices2 The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_visibility The visibility to apply to each edge specified.
- Returns
- A reference to this ShellKit.
◆ SetFaceIndexColorsByList() [1/2]
|
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. in_indices The material indices to set on the faces.
- Returns
- A reference to this ShellKit.
◆ SetFaceIndexColorsByList() [2/2]
|
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. in_index The material index to set on the faces.
- Returns
- A reference to this ShellKit.
◆ SetFaceIndexColorsByRange() [1/2]
|
inline |
◆ SetFaceIndexColorsByRange() [2/2]
|
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 ShellKit at which to start setting the color. in_count The number of faces on which to set the color. in_index The material index to set on the faces for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ SetFacelist()
|
inline |
◆ SetFaceNormalsByList() [1/2]
|
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. in_normals The normals to set on the faces.
- Returns
- A reference to this ShellKit.
◆ SetFaceNormalsByList() [2/2]
|
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. in_normal The normal to set on the faces.
- Returns
- A reference to this ShellKit.
◆ SetFaceNormalsByRange() [1/2]
|
inline |
◆ SetFaceNormalsByRange() [2/2]
|
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 ShellKit at which to start setting the normal. in_count The number of faces on which to set the normal. in_normal The normal to set on the faces for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ SetFaceRGBColorsByList() [1/2]
|
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. in_rgb_colors The RGB colors to set on the faces.
- Returns
- A reference to this ShellKit.
◆ SetFaceRGBColorsByList() [2/2]
|
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. in_rgb_color The RGB color to set on the faces.
- Returns
- A reference to this ShellKit.
◆ SetFaceRGBColorsByRange() [1/2]
|
inline |
◆ SetFaceRGBColorsByRange() [2/2]
|
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 ShellKit at which to start setting the color. in_count The number of faces on which to set the color. in_rgb_color The RGB color to set on the faces for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ SetFaceVisibilitiesByList() [1/2]
|
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. in_visibilities The visibilities to set on the faces.
- Returns
- A reference to this ShellKit.
◆ SetFaceVisibilitiesByList() [2/2]
|
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. in_visibility The visibility to set on the faces.
- Returns
- A reference to this ShellKit.
◆ SetFaceVisibilitiesByRange() [1/2]
|
inline |
◆ SetFaceVisibilitiesByRange() [2/2]
|
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 ShellKit at which to start setting the visibility. in_count The number of faces on which to set the visibility. in_visibility The visibility to set on the faces for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ SetMaterialMapping()
|
inline |
Sets the specified material mappings on this ShellKit. If this kit is used to insert a shell, only face, back face, cut edge, cut face, edge, and vertex materials will be set on the inserted shell. These material settings will be "global" for the shell, i.e., all types will get the material for that type. To get different materials for the same types, e.g., faces with different colors, it is necessary to use the per-vertex or per-face functions.
- Parameters
-
in_kit The material mappings to set on this ShellKit.
- Returns
- A reference to this ShellKit.
◆ SetPoints()
|
inline |
◆ SetPriority()
|
inline |
Assigns a specific drawing priority value to the ShellKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.
- Parameters
-
in_priority The drawing priority, higher priority items are drawn on top of lower priority items.
- Returns
- A reference to this object.
- See also
- SubwindowKit.SetPriority()
- SubwindowKit.SetRenderingAlgorithm()
◆ SetTristrips()
|
inline |
◆ SetUserData() [1/3]
|
inline |
Sets user data on this kit.
- Parameters
-
in_index The index of the user data to set. in_bytes The number of bytes of user data to set. in_data The bytes of user data to set.
- Returns
- A reference to this kit.
◆ SetUserData() [2/3]
|
inline |
Sets user data on this kit.
- Parameters
-
in_index The index of the user data to set. in_data The bytes of user data to set.
- Returns
- A reference to this kit.
◆ SetUserData() [3/3]
|
inline |
Sets user data on this kit.
- Parameters
-
in_indices An array of user data indices to set. in_data An array of bytes of user data to set.
- Returns
- A reference to this kit.
◆ SetVertexIndexColorsByList() [1/4]
|
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. 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 ShellKit.
◆ SetVertexIndexColorsByList() [2/4]
|
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. in_indices The material indices to set on the vertices.
- Returns
- A reference to this ShellKit.
◆ SetVertexIndexColorsByList() [3/4]
|
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. 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 ShellKit.
◆ SetVertexIndexColorsByList() [4/4]
|
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. in_index The material index to set on the vertices.
- Returns
- A reference to this ShellKit.
◆ SetVertexIndexColorsByRange() [1/4]
|
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 ShellKit at which to start setting colors. in_indices The material indices to set on the vertices for this ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKit.
◆ SetVertexIndexColorsByRange() [2/4]
|
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 ShellKit at which to start setting colors. in_indices The material indices to set on the vertices for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ SetVertexIndexColorsByRange() [3/4]
|
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 ShellKit at which to start setting the color. in_count The number of vertices on which to set the color. in_index The material index to set on the vertices for this ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKit.
◆ SetVertexIndexColorsByRange() [4/4]
|
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 ShellKit at which to start setting the color. in_count The number of vertices on which to set the color. in_index The material index to set on the vertices for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ SetVertexNormalsByList() [1/2]
|
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. in_normals The normals to set on the vertices.
- Returns
- A reference to this ShellKit.
◆ SetVertexNormalsByList() [2/2]
|
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. in_normal The normal to set on the vertices.
- Returns
- A reference to this ShellKit.
◆ SetVertexNormalsByRange() [1/2]
|
inline |
◆ SetVertexNormalsByRange() [2/2]
|
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 ShellKit at which to start setting the normal. in_count The number of vertices on which to set the normal. in_normal The normal to set on the vertices for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ SetVertexParametersByList() [1/2]
|
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. in_params The texture parameters to set on the vertices for this ShellKit. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored. in_param_width The number of texture parameters per vertex. Defaults to 2.
- Returns
- A reference to this ShellKit.
◆ SetVertexParametersByList() [2/2]
|
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. in_params The texture parameters to set on the vertices for this ShellKit. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored.
- Returns
- A reference to this ShellKit.
◆ SetVertexParametersByRange() [1/2]
|
inline |
Sets texture parameters on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start setting texture parameters. in_params The texture parameters to set on the vertices for this ShellKit. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored. in_param_width The number of texture parameters per vertex. Defaults to 2.
- Returns
- A reference to this ShellKit.
◆ SetVertexParametersByRange() [2/2]
|
inline |
Sets texture parameters on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start setting texture parameters. in_params The texture parameters to set on the vertices for this ShellKit. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored.
- Returns
- A reference to this ShellKit.
◆ SetVertexRGBAColorsByList() [1/4]
|
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. 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 ShellKit.
◆ SetVertexRGBAColorsByList() [2/4]
|
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. in_rgba_colors The RGBA colors to set on the vertices.
- Returns
- A reference to this ShellKit.
◆ SetVertexRGBAColorsByList() [3/4]
|
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. 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 ShellKit.
◆ SetVertexRGBAColorsByList() [4/4]
|
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. in_rgba_color The RGBA color to set on the vertices.
- Returns
- A reference to this ShellKit.
◆ SetVertexRGBAColorsByRange() [1/4]
|
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 ShellKit at which to start setting colors. in_rgba_colors The RGBA colors to set on the vertices for this ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKit.
◆ SetVertexRGBAColorsByRange() [2/4]
|
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 ShellKit at which to start setting colors. in_rgba_colors The RGBA colors to set on the vertices for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ SetVertexRGBAColorsByRange() [3/4]
|
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 ShellKit at which to start setting the color. in_count The number of vertices on which to set the color. in_rgba_color The RGBA color to set on the vertices for this ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKit.
◆ SetVertexRGBAColorsByRange() [4/4]
|
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 ShellKit at which to start setting the color. in_count The number of vertices on which to set the color. in_rgba_color The RGBA color to set on the vertices for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ SetVertexRGBColorsByList() [1/4]
|
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. 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 ShellKit.
◆ SetVertexRGBColorsByList() [2/4]
|
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. in_rgb_colors The RGB colors to set on the vertices.
- Returns
- A reference to this ShellKit.
◆ SetVertexRGBColorsByList() [3/4]
|
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. 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 ShellKit.
◆ SetVertexRGBColorsByList() [4/4]
|
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. in_rgb_color The RGB color to set on the vertices.
- Returns
- A reference to this ShellKit.
◆ SetVertexRGBColorsByRange() [1/4]
|
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 ShellKit at which to start setting colors. in_rgb_colors The RGB colors to set on the vertices for this ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKit.
◆ SetVertexRGBColorsByRange() [2/4]
|
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 ShellKit at which to start setting colors. in_rgb_colors The RGB colors to set on the vertices for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ SetVertexRGBColorsByRange() [3/4]
|
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 ShellKit at which to start setting the color. in_count The number of vertices on which to set the color. in_rgb_color The RGB color to set on the vertices for this ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell.Component.Faces.
- Returns
- A reference to this ShellKit.
◆ SetVertexRGBColorsByRange() [4/4]
|
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 ShellKit at which to start setting the color. in_count The number of vertices on which to set the color. in_rgb_color The RGB color to set on the vertices for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ SetVertexVisibilitiesByList() [1/2]
|
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. in_visibilities The visibilities to set on the vertices.
- Returns
- A reference to this ShellKit.
◆ SetVertexVisibilitiesByList() [2/2]
|
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. in_visibility The visibility to set on the vertices.
- Returns
- A reference to this ShellKit.
◆ SetVertexVisibilitiesByRange() [1/2]
|
inline |
◆ SetVertexVisibilitiesByRange() [2/2]
|
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 ShellKit at which to start setting the visibility. in_count The number of vertices on which to set the visibility. in_visibility The visibility to set on the vertices for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ Show()
|
inline |
◆ ShowEdgeColors()
|
inline |
Sets edge colors on a selection of arbitrary edges.
- Parameters
-
out_vertices1 The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. out_vertices2 The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. out_types The types of edge colors for each edge. out_rgb_colors The colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is RGBColor. out_indices The colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is MaterialIndex.
- Returns
- A reference to this ShellKit.
◆ ShowEdgeColorsByList()
|
inline |
Sets edge colors on a selection of arbitrary edges.
- Parameters
-
in_vertices1 The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_vertices2 The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. out_types The types of edge colors for each edge. out_rgb_colors The colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is Material.Type.RGBColor. out_indices The colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is Material.Type.MaterialIndex.
- Returns
- A reference to this ShellKit.
◆ ShowEdgeVisibilitiesByList()
|
inline |
Shows all the edge visibilities on this ShellKit.
- Parameters
-
in_vertices1 The vertex indices that correspond to the start position of each edge for which the visibilities are being shown. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_vertices2 The vertex indices that correspond to the end position of each edge for which the visibilities are being shown. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. out_validities The validities of the visibilities for each edge. If an edge has a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The edge visibilities for each edge. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any vertex had a vertex visibility set, false otherwise.
◆ ShowFaceColors()
|
inline |
Shows all the face colors on this ShellKit.
- 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.
◆ ShowFaceColorsByList()
|
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. 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.
◆ ShowFaceColorsByRange()
|
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 ShellKit at which to start showing colors. in_count The number of colors to show. out_types The types of face colors for each face in the specified range. If a face in the specified range does not have a face color set, the entry in this array will be Material.Type.None. out_rgb_colors The RGB colors for each face in the specified range. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor. out_indices The material indices for each face in the specified range. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
- Returns
- true if any face in the specified range had a face color set, false otherwise.
◆ ShowFacelist()
|
inline |
◆ ShowFaceNormals()
|
inline |
Shows the all face normals on this ShellKit.
- 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.
◆ ShowFaceNormalsByList()
|
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. 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.
◆ ShowFaceNormalsByRange()
|
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 ShellKit at which to start showing normals. in_count The number of normals to show. out_validities The validities of the normals for each face in the specified range. If a face in the specified range had a normal set on it, the entry in this array will be true, otherwise it will be false. out_normals The face normals for each face in the specified range. out_normals[i] is only valid if out_validities[i] is true.
- Returns
- true if any face in the specified range had a face normal set, false otherwise.
◆ ShowFaceVisibilities()
|
inline |
Shows all the face visibilities on this ShellKit.
- 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.
◆ ShowFaceVisibilitiesByList()
|
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. 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.
◆ ShowFaceVisibilitiesByRange()
|
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 ShellKit at which to start showing visibilities. in_count The number of visibilities to show. out_validities The validities of the visibilities for each face in the specified range. If a face in the specified range had a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The face visibilities for each face in the specified range. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any face in the specified range had a face visibility set, false otherwise.
◆ ShowMaterialMapping()
|
inline |
◆ ShowPoints()
|
inline |
◆ ShowPointsByList()
|
inline |
◆ ShowPointsByRange()
|
inline |
◆ ShowPriority()
|
inline |
Shows the drawing priority.
- Parameters
-
out_priority The drawing priority, higher priority items are drawn on top of lower priority items.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowTristrips()
|
inline |
◆ ShowUserData() [1/2]
|
inline |
Shows the user data at a given index for this kit.
- Parameters
-
in_index The index of the user data to show. out_data The user data at the given index.
- Returns
- true if there is user data at the given index, false otherwise.
◆ ShowUserData() [2/2]
|
inline |
Shows all user data for this kit.
- Parameters
-
out_indices An array of all user data indices set on this kit. out_data An array of all user data set on this kit.
- Returns
- true if there is user data on this kit, false otherwise.
◆ ShowUserDataCount()
|
inline |
Get the number of user data indices set on this kit.
◆ ShowUserDataIndices()
|
inline |
Shows the indices of all user data set on this kit.
- Parameters
-
out_indices The user data indices set on this kit.
- Returns
- The number of user data indices set on this kit.
◆ ShowVertexColors()
|
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.
◆ ShowVertexColorsByList()
|
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. 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.
◆ ShowVertexColorsByRange()
|
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 ShellKit at which to start showing colors. in_count The number of colors to show. 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.
◆ ShowVertexNormals()
|
inline |
Shows all the vertex normals on this ShellKit.
- 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.
◆ ShowVertexNormalsByList()
|
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. 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.
◆ ShowVertexNormalsByRange()
|
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 ShellKit at which to start showing normals. in_count The number of normals to show. out_validities The validities of the normals for each vertex in the specified range. If a vertex in the specified range had a normal set on it, the entry in this array will be true, otherwise it will be false. out_normals The vertex normals for each vertex in the specified range. out_normals[i] is only valid if out_validities[i] is true.
- Returns
- true if any vertex in the specified range had a vertex normal set, false otherwise.
◆ ShowVertexParameters() [1/2]
|
inline |
Shows the texture parameters on all of the vertices in this ShellKit. For this particular show function, the parameter width is returned implicitly and could be determined by out_params.size()/in_count.
- Parameters
-
out_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.
◆ ShowVertexParameters() [2/2]
|
inline |
Shows the texture parameters on all of the vertices in this ShellKit.
- 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.
◆ ShowVertexParametersByList() [1/2]
|
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. 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.
◆ ShowVertexParametersByList() [2/2]
|
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. 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.
◆ ShowVertexParametersByRange() [1/2]
|
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 ShellKit at which to start showing texture parameters. in_count The number of vertices for which to show the texture parameters. out_validities The validities of the texture parameters for each vertex in the specified range. If a vertex in the specified range had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params The texture parameters for each vertex in the specified range. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
- Returns
- true if any vertex in the specified range had a texture parameter set, false otherwise.
◆ ShowVertexParametersByRange() [2/2]
|
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 ShellKit at which to start showing texture parameters. in_count The number of vertices for which to show the texture parameters. out_validities The validities of the texture parameters for each vertex in the specified range. If a vertex in the specified range had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params The texture parameters for each vertex in the specified range. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true. out_param_width The number of texture parameters per vertex.
- Returns
- true if any vertex in the specified range had a texture parameter set, false otherwise.
◆ ShowVertexVisibilities()
|
inline |
Shows all the vertex visibilities on this ShellKit
- 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.
◆ ShowVertexVisibilitiesByList()
|
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. 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.
◆ ShowVertexVisibilitiesByRange()
|
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 ShellKit at which to start showing visibilities. in_count The number of visibilities to show. out_validities The validities of the visibilities for each vertex in the specified range. If a vertex in the specified range had a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The vertex visibilities for each vertex in the specified range. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any vertex in the specified range had a vertex visibility set, false otherwise.
◆ UnsetAllUserData()
|
inline |
Removes all user data from this kit.
- Returns
- A reference to this kit.
◆ UnsetEdgeColors()
|
inline |
Unsets edge colors on all edges.
- Returns
- A reference to this ShellKit.
◆ UnsetEdgeColorsByList()
|
inline |
Unsets edge colors on a selection of arbitrary edges.
- Parameters
-
in_vertices1 The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_vertices2 The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
- Returns
- A reference to this ShellKit.
◆ UnsetEdgeEverything()
|
inline |
◆ UnsetEdgeVisibilities()
|
inline |
Removes all vertex visibilities.
- Returns
- A reference to this ShellKit.
◆ UnsetEdgeVisibilitiesByList()
|
inline |
Unsets edge visibilities on a selection of arbitrary edges.
- Parameters
-
in_vertices1 The vertex indices that correspond to the start position of each edge for which the visibilities are being unset. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_vertices2 The vertex indices that correspond to the end position of each edge for which the visibilities are being unset. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
- Returns
- A reference to this ShellKit.
◆ UnsetEverything()
|
inline |
◆ UnsetFaceColors()
|
inline |
Removes all face colors (RGB colors or material indices).
- Returns
- A reference to this ShellKit.
◆ UnsetFaceColorsByList()
|
inline |
Removes the face colors (RGB colors or material indices) on a selection of arbitrary vertices.
- Parameters
-
in_faces The indices of the faces on which to remove the colors.
- Returns
- A reference to this ShellKit.
◆ UnsetFaceColorsByRange()
|
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 ShellKit at which to start removing colors. in_count The number of face colors to remove for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ UnsetFaceEverything()
|
inline |
◆ UnsetFacelist()
|
inline |
◆ UnsetFaceNormals()
|
inline |
Removes all face normals.
- Returns
- A reference to this ShellKit.
◆ UnsetFaceNormalsByList()
|
inline |
Removes the face normals on a selection of arbitrary faces.
- Returns
- A reference to this ShellKit.
◆ UnsetFaceNormalsByRange()
|
inline |
◆ UnsetFaceVisibilities()
|
inline |
Removes all face visibilities.
- Returns
- A reference to this ShellKit.
◆ UnsetFaceVisibilitiesByRange()
|
inline |
◆ UnsetMaterialMapping()
|
inline |
◆ UnsetPoints()
|
inline |
◆ UnsetPriority()
|
inline |
Removes a drawing priority setting.
- Returns
- A reference to this object.
◆ UnsetTristrips()
|
inline |
◆ UnsetUserData() [1/2]
|
inline |
Removes the user data at the given index from this kit.
- Parameters
-
in_index The index of the user data to remove.
- Returns
- A reference to this kit.
◆ UnsetUserData() [2/2]
|
inline |
Removes the user data at the given indices from this kit.
- Parameters
-
in_indices The indices of the user data to remove.
- Returns
- A reference to this kit.
◆ UnsetVertexColors() [1/2]
|
inline |
Removes all vertex colors (RGB colors, RGBA colors, or material indices) for all shell components.
- Returns
- A reference to this ShellKit.
◆ UnsetVertexColors() [2/2]
|
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 ShellKit.
◆ UnsetVertexColorsByList() [1/2]
|
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.
- Returns
- A reference to this ShellKit.
◆ UnsetVertexColorsByList() [2/2]
|
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. in_apply_to The shell component for which to remove the colors.
- Returns
- A reference to this ShellKit.
◆ UnsetVertexColorsByRange() [1/2]
|
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 ShellKit at which to start removing colors. in_count The number of vertex colors to remove for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ UnsetVertexColorsByRange() [2/2]
|
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 ShellKit at which to start removing colors. in_count The number of vertex colors to remove for this ShellKit. in_apply_to The shell component for which to remove the colors.
- Returns
- A reference to this ShellKit.
◆ UnsetVertexEverything()
|
inline |
◆ UnsetVertexNormals()
|
inline |
Removes all vertex normals.
- Returns
- A reference to this ShellKit.
◆ UnsetVertexNormalsByList()
|
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.
- Returns
- A reference to this ShellKit.
◆ UnsetVertexNormalsByRange()
|
inline |
◆ UnsetVertexParameters()
|
inline |
Removes all texture parameters.
- Returns
- A reference to this ShellKit.
◆ UnsetVertexParametersByList()
|
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.
- Returns
- A reference to this ShellKit.
◆ UnsetVertexParametersByRange()
|
inline |
Removes the specified range of texture parameters starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start removing texture parameters. in_count The number of texture parameters to remove for this ShellKit.
- Returns
- A reference to this ShellKit.
◆ UnsetVertexVisibilities()
|
inline |
Removes all vertex visibilities.
- Returns
- A reference to this ShellKit.
◆ UnsetVertexVisibilitiesByList()
|
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.
- Returns
- A reference to this ShellKit.
◆ UnsetVertexVisibilitiesByRange()
|
inline |
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.ShellKit.cs