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

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.ShellKey EditFacelistByDeletion (ulong in_offset, ulong in_count)
 
HPS.ShellKey EditFacelistByInsertion (ulong in_offset, int[] in_facelist)
 
HPS.ShellKey EditFacelistByReplacement (ulong in_offset, int[] in_facelist)
 
HPS.ShellKey EditPointsByDeletion (ulong in_offset, ulong in_count)
 
HPS.ShellKey EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points)
 
HPS.ShellKey EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)
 
ulong GetFaceCount ()
 
ulong GetPointCount ()
 
override HPS.Type ObjectType ()
 
void Optimize (HPS.ShellOptimizationOptionsKit in_shell_optimization_kit)
 
void Set (HPS.ShellKit in_kit)
 
HPS.ShellKey SetEdgeIndexColorsByList (ulong[] in_vertices1, ulong[] in_vertices2, float[] in_indices)
 
HPS.ShellKey SetEdgeIndexColorsByList (ulong[] in_vertices1, ulong[] in_vertices2, float in_index)
 
HPS.ShellKey SetEdgeRGBColorsByList (ulong[] in_vertices1, ulong[] in_vertices2, HPS.RGBColor[] in_rgb_colors)
 
HPS.ShellKey SetEdgeRGBColorsByList (ulong[] in_vertices1, ulong[] in_vertices2, HPS.RGBColor in_rgb_color)
 
HPS.ShellKey SetEdgeVisibilitiesByList (ulong[] in_vertices1, ulong[] in_vertices2, bool[] in_visibilities)
 
HPS.ShellKey SetEdgeVisibilitiesByList (ulong[] in_vertices1, ulong[] in_vertices2, bool in_visibility)
 
HPS.ShellKey SetFaceIndexColorsByList (ulong[] in_faces, float[] in_indices)
 
HPS.ShellKey SetFaceIndexColorsByList (ulong[] in_faces, float in_index)
 
HPS.ShellKey SetFaceIndexColorsByRange (ulong in_start, float[] in_indices)
 
HPS.ShellKey SetFaceIndexColorsByRange (ulong in_start, ulong in_count, float in_index)
 
HPS.ShellKey SetFacelist (int[] in_facelist)
 
HPS.ShellKey SetFaceNormalsByList (ulong[] in_faces, HPS.Vector[] in_normals)
 
HPS.ShellKey SetFaceNormalsByList (ulong[] in_faces, HPS.Vector in_normal)
 
HPS.ShellKey SetFaceNormalsByRange (ulong in_start, HPS.Vector[] in_normals)
 
HPS.ShellKey SetFaceNormalsByRange (ulong in_start, ulong in_count, HPS.Vector in_normal)
 
HPS.ShellKey SetFaceRGBColorsByList (ulong[] in_faces, HPS.RGBColor[] in_rgb_colors)
 
HPS.ShellKey SetFaceRGBColorsByList (ulong[] in_faces, HPS.RGBColor in_rgb_color)
 
HPS.ShellKey SetFaceRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors)
 
HPS.ShellKey SetFaceRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color)
 
HPS.ShellKey SetFaceVisibilitiesByList (ulong[] in_faces, bool[] in_visibilities)
 
HPS.ShellKey SetFaceVisibilitiesByList (ulong[] in_faces, bool in_visibility)
 
HPS.ShellKey SetFaceVisibilitiesByRange (ulong in_start, bool[] in_visibilities)
 
HPS.ShellKey SetFaceVisibilitiesByRange (ulong in_start, ulong in_count, bool in_visibility)
 
HPS.ShellKey SetMaterialMapping (HPS.MaterialMappingKit in_kit)
 
HPS.ShellKey SetPoints (HPS.Point[] in_points)
 
HPS.ShellKey SetTristrips (int[] in_tristrips)
 
HPS.ShellKey SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices, HPS.Shell.Component in_apply_to)
 
HPS.ShellKey SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices)
 
HPS.ShellKey SetVertexIndexColorsByList (ulong[] in_vertices, float in_index, HPS.Shell.Component in_apply_to)
 
HPS.ShellKey SetVertexIndexColorsByList (ulong[] in_vertices, float in_index)
 
HPS.ShellKey SetVertexIndexColorsByRange (ulong in_start, float[] in_indices, HPS.Shell.Component in_apply_to)
 
HPS.ShellKey SetVertexIndexColorsByRange (ulong in_start, float[] in_indices)
 
HPS.ShellKey SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index, HPS.Shell.Component in_apply_to)
 
HPS.ShellKey SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index)
 
HPS.ShellKey SetVertexNormalsByList (ulong[] in_vertices, HPS.Vector[] in_normals)
 
HPS.ShellKey SetVertexNormalsByList (ulong[] in_vertices, HPS.Vector in_normal)
 
HPS.ShellKey SetVertexNormalsByRange (ulong in_start, HPS.Vector[] in_normals)
 
HPS.ShellKey SetVertexNormalsByRange (ulong in_start, ulong in_count, HPS.Vector in_normal)
 
HPS.ShellKey SetVertexParametersByList (ulong[] in_vertices, float[] in_params, ulong in_param_width)
 
HPS.ShellKey SetVertexParametersByList (ulong[] in_vertices, float[] in_params)
 
HPS.ShellKey SetVertexParametersByRange (ulong in_start, float[] in_params, ulong in_param_width)
 
HPS.ShellKey SetVertexParametersByRange (ulong in_start, float[] in_params)
 
HPS.ShellKey SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor[] in_rgba_colors, HPS.Shell.Component in_apply_to)
 
HPS.ShellKey SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor[] in_rgba_colors)
 
HPS.ShellKey SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor in_rgba_color, HPS.Shell.Component in_apply_to)
 
HPS.ShellKey SetVertexRGBAColorsByList (ulong[] in_vertices, HPS.RGBAColor in_rgba_color)
 
HPS.ShellKey SetVertexRGBAColorsByRange (ulong in_start, HPS.RGBAColor[] in_rgba_colors, HPS.Shell.Component in_apply_to)
 
HPS.ShellKey SetVertexRGBAColorsByRange (ulong in_start, HPS.RGBAColor[] in_rgba_colors)
 
HPS.ShellKey SetVertexRGBAColorsByRange (ulong in_start, ulong in_count, HPS.RGBAColor in_rgba_color, HPS.Shell.Component in_apply_to)
 
HPS.ShellKey SetVertexRGBAColorsByRange (ulong in_start, ulong in_count, HPS.RGBAColor in_rgba_color)
 
HPS.ShellKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors, HPS.Shell.Component in_apply_to)
 
HPS.ShellKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors)
 
HPS.ShellKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color, HPS.Shell.Component in_apply_to)
 
HPS.ShellKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color)
 
HPS.ShellKey SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors, HPS.Shell.Component in_apply_to)
 
HPS.ShellKey SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors)
 
HPS.ShellKey SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color, HPS.Shell.Component in_apply_to)
 
HPS.ShellKey SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color)
 
HPS.ShellKey SetVertexVisibilitiesByList (ulong[] in_vertices, bool[] in_visibilities)
 
HPS.ShellKey SetVertexVisibilitiesByList (ulong[] in_vertices, bool in_visibility)
 
HPS.ShellKey SetVertexVisibilitiesByRange (ulong in_start, bool[] in_visibilities)
 
HPS.ShellKey SetVertexVisibilitiesByRange (ulong in_start, ulong in_count, bool in_visibility)
 
 ShellKey ()
 
 ShellKey (HPS.Key in_that)
 
 ShellKey (HPS.ShellKey in_that)
 
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 ShowNetFaceNormalsByList (ulong[] in_faces, out HPS.Vector[] out_normals)
 
bool ShowNetFaceNormalsByRange (ulong in_start, ulong in_count, out HPS.Vector[] out_normals)
 
bool ShowNetVertexNormals (out HPS.Vector[] out_normals, HPS.Drawing.Handedness in_polygon_handedness)
 
bool ShowNetVertexNormals (out HPS.Vector[] out_normals)
 
bool ShowNetVertexNormalsByRange (ulong in_start, ulong in_count, out HPS.Vector[] out_normals, HPS.Drawing.Handedness in_polygon_handedness)
 
bool ShowNetVertexNormalsByRange (ulong in_start, ulong in_count, out HPS.Vector[] out_normals)
 
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 ShowTristrips (out int[] out_tristrips)
 
bool ShowTristrips (out int[] out_tristrips, out int[] out_face_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.ShellKey UnsetEdgeColors ()
 
HPS.ShellKey UnsetEdgeColorsByList (ulong[] in_vertices1, ulong[] in_vertices2)
 
HPS.ShellKey UnsetEdgeEverything ()
 
HPS.ShellKey UnsetEdgeVisibilities ()
 
HPS.ShellKey UnsetEdgeVisibilitiesByList (ulong[] in_vertices1, ulong[] in_vertices2)
 
HPS.ShellKey UnsetEverything ()
 
HPS.ShellKey UnsetFaceColors ()
 
HPS.ShellKey UnsetFaceColorsByList (ulong[] in_faces)
 
HPS.ShellKey UnsetFaceColorsByRange (ulong in_start, ulong in_count)
 
HPS.ShellKey UnsetFaceEverything ()
 
HPS.ShellKey UnsetFacelist ()
 
HPS.ShellKey UnsetFaceNormals ()
 
HPS.ShellKey UnsetFaceNormalsByList (ulong[] in_vertices)
 
HPS.ShellKey UnsetFaceNormalsByRange (ulong in_start, ulong in_count)
 
HPS.ShellKey UnsetFaceVisibilities ()
 
HPS.ShellKey UnsetFaceVisibilitiesByList (ulong[] in_faces)
 
HPS.ShellKey UnsetFaceVisibilitiesByRange (ulong in_start, ulong in_count)
 
HPS.ShellKey UnsetMaterialMapping ()
 
HPS.ShellKey UnsetPoints ()
 
HPS.ShellKey UnsetTristrips ()
 
HPS.ShellKey UnsetVertexColors ()
 
HPS.ShellKey UnsetVertexColors (HPS.Shell.Component in_apply_to)
 
HPS.ShellKey UnsetVertexColorsByList (ulong[] in_vertices)
 
HPS.ShellKey UnsetVertexColorsByList (ulong[] in_vertices, HPS.Shell.Component in_apply_to)
 
HPS.ShellKey UnsetVertexColorsByRange (ulong in_start, ulong in_count)
 
HPS.ShellKey UnsetVertexColorsByRange (ulong in_start, ulong in_count, HPS.Shell.Component in_apply_to)
 
HPS.ShellKey UnsetVertexEverything ()
 
HPS.ShellKey UnsetVertexNormals ()
 
HPS.ShellKey UnsetVertexNormalsByList (ulong[] in_vertices)
 
HPS.ShellKey UnsetVertexNormalsByRange (ulong in_start, ulong in_count)
 
HPS.ShellKey UnsetVertexParameters ()
 
HPS.ShellKey UnsetVertexParametersByList (ulong[] in_vertices)
 
HPS.ShellKey UnsetVertexParametersByRange (ulong in_start, ulong in_count)
 
HPS.ShellKey UnsetVertexVisibilities ()
 
HPS.ShellKey UnsetVertexVisibilitiesByList (ulong[] in_vertices)
 
HPS.ShellKey UnsetVertexVisibilitiesByRange (ulong in_start, ulong in_count)
 
- Public Member Functions inherited from HPS.GeometryKey
 GeometryKey ()
 
 GeometryKey (HPS.Key in_that)
 
 GeometryKey (HPS.GeometryKey in_that)
 
HPS.GeometryKey SetPriority (int in_priority)
 
HPS.GeometryKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
bool ShowBounding (out HPS.BoundingKit out_kit)
 
bool ShowPriority (out int out_priority)
 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 
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)
 
HPS.GeometryKey UnsetAllUserData ()
 
HPS.GeometryKey UnsetPriority ()
 
HPS.GeometryKey UnsetUserData (IntPtr in_index)
 
HPS.GeometryKey UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 
void Delete ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 
ulong GetHash ()
 
override int GetHashCode ()
 
bool HasOwner ()
 
 Key ()
 
 Key (HPS.Key in_that)
 
 Key (HPS.Control in_control)
 
void MoveTo (HPS.SegmentKey in_new_owner)
 
HPS.SegmentKey Owner ()
 
HPS.SegmentKey Up ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

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

Additional Inherited Members

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

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

◆ ShellKey() [1/3]

HPS.ShellKey.ShellKey ( )
inline

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

◆ ShellKey() [2/3]

HPS.ShellKey.ShellKey ( HPS.Key  in_that)
inline

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.

◆ ShellKey() [3/3]

HPS.ShellKey.ShellKey ( HPS.ShellKey  in_that)
inline

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

Parameters
in_thatThe source ShellKey to copy.

Member Function Documentation

◆ ComputeRelation() [1/3]

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

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

Parameters
in_pointsAn array of points to test against this shell.
in_optionsThe options to use when performing the relation test.
out_resultsThe results of the relation test.

◆ ComputeRelation() [2/3]

void HPS.ShellKey.ComputeRelation ( HPS.ShellKey  in_points_source,
HPS.ShellRelationOptionsKit  in_options,
out HPS.ShellRelationResultsKit  out_results 
)
inline

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

Parameters
in_points_sourceA shell whose points should be tested against this shell.
in_optionsThe options to use when performing the relation test.
out_resultsThe results of the relation test.

◆ ComputeRelation() [3/3]

void HPS.ShellKey.ComputeRelation ( HPS.ShellKit  in_points_source,
HPS.ShellRelationOptionsKit  in_options,
out HPS.ShellRelationResultsKit  out_results 
)
inline

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

Parameters
in_points_sourceA shell whose points should be tested against this shell.
in_optionsThe options to use when performing the relation test.
out_resultsThe results of the relation test.

◆ Consume()

void HPS.ShellKey.Consume ( HPS.ShellKit  in_kit)
inline

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

Parameters
in_kitThe kit from which to get the settings to replace on this ShellKey.

◆ EditFacelistByDeletion()

HPS.ShellKey HPS.ShellKey.EditFacelistByDeletion ( ulong  in_offset,
ulong  in_count 
)
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_offsetThe offset into the faces for the shell at which to start removing faces. This value must be such that in_offset<face_count for deletion to succeed. This is not an offset into the raw face list, but is relative to the actual face count for the shell.
in_countThe number of faces to remove from the face list for the shell. This value must be such that in_offset+in_count<=face_count for the deletion to succeed.
Returns
A reference to this ShellKey.

◆ EditFacelistByInsertion()

HPS.ShellKey HPS.ShellKey.EditFacelistByInsertion ( ulong  in_offset,
int []  in_facelist 
)
inline

Adds faces to the face list for this ShellKey.

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

◆ EditFacelistByReplacement()

HPS.ShellKey HPS.ShellKey.EditFacelistByReplacement ( ulong  in_offset,
int []  in_facelist 
)
inline

Replaces faces in the face list for this ShellKey.

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

◆ EditPointsByDeletion()

HPS.ShellKey HPS.ShellKey.EditPointsByDeletion ( ulong  in_offset,
ulong  in_count 
)
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_offsetThe offset into the point list for the shell at which to start removing points. This value must be such that in_offset<point_count for deletion to succeed.
in_countThe number of points to delete from the point list for the shell. This value must be such that in_offset+in_count<=point_count for the deletion to succeed.
Returns
A reference to this ShellKey.

◆ EditPointsByInsertion()

HPS.ShellKey HPS.ShellKey.EditPointsByInsertion ( ulong  in_offset,
HPS.Point []  in_points 
)
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_offsetThe offset into the point list for the shell at which to insert points. This value must be such that in_offset<point_count for insertion to succeed.
in_pointsThe points to insert into the point list at the specified offset.
Returns
A reference to this ShellKey.

◆ EditPointsByReplacement()

HPS.ShellKey HPS.ShellKey.EditPointsByReplacement ( ulong  in_offset,
HPS.Point []  in_points 
)
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_offsetThe offset into the point list for the shell at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed.
in_pointsThe points to use to replace those in the point list at the specified offset. This size of the array must be such that in_offset+in_points.size()<=point_count for the replacement to succeed.
Returns
A reference to this ShellKey.

◆ GetFaceCount()

ulong HPS.ShellKey.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()

ulong HPS.ShellKey.GetPointCount ( )
inline

Retrieves the number of points in this shell.

Returns
The number of points in this shell.

◆ ObjectType()

override HPS.Type HPS.ShellKey.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.GeometryKey.

◆ Optimize()

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

Optimizes the shell using the parameters set in a ShellOptimizationOptionsKit

◆ Set()

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

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

Parameters
in_kitThe kit from which to get the settings to replace on this ShellKey.

◆ SetEdgeIndexColorsByList() [1/2]

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

Sets edge material indices on a selection of arbitrary edges.

Parameters
in_vertices1The 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_vertices2The 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_indicesThe material indices to set on the edges.
Returns
A reference to this ShellKey.

◆ SetEdgeIndexColorsByList() [2/2]

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

Sets edge material indices on a selection of arbitrary edges.

Parameters
in_vertices1The 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_vertices2The 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_indexThe material index to set on the edges.
Returns
A reference to this ShellKey.

◆ SetEdgeRGBColorsByList() [1/2]

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

Sets edge colors on a selection of arbitrary edges.

Parameters
in_vertices1The 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_vertices2The 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_colorsThe colors to set on the edges.
Returns
A reference to this ShellKey.

◆ SetEdgeRGBColorsByList() [2/2]

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

Sets edge colors on a selection of arbitrary edges.

Parameters
in_vertices1The 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_vertices2The 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_colorThe color to set on the edges.
Returns
A reference to this ShellKey.

◆ SetEdgeVisibilitiesByList() [1/2]

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

Sets edge visibilities on a selection of arbitrary edges.

Parameters
in_vertices1The 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_vertices2The 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_visibilitiesThe visibilities that should be set for each edge specified.
Returns
A reference to this ShellKey.

◆ SetEdgeVisibilitiesByList() [2/2]

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

Sets edge visibilities on a selection of arbitrary edges.

Parameters
in_vertices1The 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_vertices2The 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_visibilityThe visibility to apply to each edge specified.
Returns
A reference to this ShellKey.

◆ SetFaceIndexColorsByList() [1/2]

HPS.ShellKey HPS.ShellKey.SetFaceIndexColorsByList ( ulong []  in_faces,
float []  in_indices 
)
inline

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

Parameters
in_facesThe indices of the faces on which to set the colors. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_indicesThe material indices to set on the faces.
Returns
A reference to this ShellKey.

◆ SetFaceIndexColorsByList() [2/2]

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

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

Parameters
in_facesThe indices of the faces on which to set the color. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_indexThe material index to set on the faces.
Returns
A reference to this ShellKey.

◆ SetFaceIndexColorsByRange() [1/2]

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

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

Parameters
in_startThe offset into the faces for this ShellKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed.
in_indicesThe material indices to set on the faces for this 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.

◆ SetFaceIndexColorsByRange() [2/2]

HPS.ShellKey HPS.ShellKey.SetFaceIndexColorsByRange ( ulong  in_start,
ulong  in_count,
float  in_index 
)
inline

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

Parameters
in_startThe offset into the faces for this ShellKey at which to start setting the color. This value must be such that in_start<face_count for setting to succeed.
in_countThe number of faces on which to set the color. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_indexThe material index to set on the faces for this ShellKey.
Returns
A reference to this ShellKey.

◆ SetFacelist()

HPS.ShellKey HPS.ShellKey.SetFacelist ( int []  in_facelist)
inline

Replace the face list on this ShellKey with the specified face list.

Parameters
in_facelistThe face list to use to replace the one for this ShellKey.
Returns
A reference to this ShellKey.

◆ SetFaceNormalsByList() [1/2]

HPS.ShellKey HPS.ShellKey.SetFaceNormalsByList ( ulong []  in_faces,
HPS.Vector []  in_normals 
)
inline

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

Parameters
in_facesThe indices of the faces on which to set the normals. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_normalsThe normals to set on the faces.
Returns
A reference to this ShellKey.

◆ SetFaceNormalsByList() [2/2]

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

Sets a single normal on a selection of arbitrary faces.

Parameters
in_facesThe indices of the faces on which to set the normal. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_normalThe normal to set on the faces.
Returns
A reference to this ShellKey.

◆ SetFaceNormalsByRange() [1/2]

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

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

Parameters
in_startThe offset into the faces for this ShellKey at which to start setting normals. This value must be such that in_start<face_count for setting to succeed.
in_normalsThe normals to set on the faces for this 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.

◆ SetFaceNormalsByRange() [2/2]

HPS.ShellKey HPS.ShellKey.SetFaceNormalsByRange ( ulong  in_start,
ulong  in_count,
HPS.Vector  in_normal 
)
inline

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

Parameters
in_startThe offset into the faces for this ShellKey at which to start setting the normal. This value must be such that in_start<face_count for setting to succeed.
in_countThe number of faces on which to set the normal. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_normalThe normal to set on the faces for this ShellKey.
Returns
A reference to this ShellKey.

◆ SetFaceRGBColorsByList() [1/2]

HPS.ShellKey HPS.ShellKey.SetFaceRGBColorsByList ( ulong []  in_faces,
HPS.RGBColor []  in_rgb_colors 
)
inline

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

Parameters
in_facesThe indices of the faces on which to set the colors. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_rgb_colorsThe RGB colors to set on the faces.
Returns
A reference to this ShellKey.

◆ SetFaceRGBColorsByList() [2/2]

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

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

Parameters
in_facesThe indices of the faces on which to set the color. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_rgb_colorThe RGB color to set on the faces.
Returns
A reference to this ShellKey.

◆ SetFaceRGBColorsByRange() [1/2]

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

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

Parameters
in_startThe offset into the faces for this ShellKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed.
in_rgb_colorsThe RGB colors to set on the faces for this 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.

◆ SetFaceRGBColorsByRange() [2/2]

HPS.ShellKey HPS.ShellKey.SetFaceRGBColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.RGBColor  in_rgb_color 
)
inline

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

Parameters
in_startThe offset into the faces for this ShellKey at which to start setting the color. This value must be such that in_start<face_count for setting to succeed.
in_countThe number of faces on which to set the color. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_rgb_colorThe RGB color to set on the faces for this ShellKey.
Returns
A reference to this ShellKey.

◆ SetFaceVisibilitiesByList() [1/2]

HPS.ShellKey HPS.ShellKey.SetFaceVisibilitiesByList ( ulong []  in_faces,
bool []  in_visibilities 
)
inline

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

Parameters
in_facesThe indices of the faces on which to set the visibilities. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_visibilitiesThe visibilities to set on the faces.
Returns
A reference to this ShellKey.

◆ SetFaceVisibilitiesByList() [2/2]

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

Sets a single visibility on a selection of arbitrary faces.

Parameters
in_facesThe indices of the faces on which to set the visibility. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_visibilityThe visibility to set on the faces.
Returns
A reference to this ShellKey.

◆ SetFaceVisibilitiesByRange() [1/2]

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

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

Parameters
in_startThe offset into the faces for this ShellKey at which to start setting visibilities. This value must be such that in_start<face_count for setting to succeed.
in_visibilitiesThe visibilities to set on the faces for this 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.

◆ SetFaceVisibilitiesByRange() [2/2]

HPS.ShellKey HPS.ShellKey.SetFaceVisibilitiesByRange ( ulong  in_start,
ulong  in_count,
bool  in_visibility 
)
inline

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

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

◆ SetMaterialMapping()

HPS.ShellKey HPS.ShellKey.SetMaterialMapping ( HPS.MaterialMappingKit  in_kit)
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_kitThe material mappings to set on this ShellKey.
Returns
A reference to this ShellKey.

◆ SetPoints()

HPS.ShellKey HPS.ShellKey.SetPoints ( HPS.Point []  in_points)
inline

Replace the points on this ShellKey with the specified points.

Parameters
in_pointsThe points to use to replace those for this ShellKey.
Returns
A reference to this ShellKey.

◆ SetTristrips()

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

Replace the face list on this ShellKey with the specified face list.

Parameters
in_tristripsThe tristrips list to use to replace the one for this ShellKey.
Returns
A reference to this ShellKey.

◆ SetVertexIndexColorsByList() [1/4]

HPS.ShellKey HPS.ShellKey.SetVertexIndexColorsByList ( ulong []  in_vertices,
float []  in_indices,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_indicesThe material indices to set on the vertices.
in_apply_toThe shell component the colors should apply to. Defaults to Shell.Component.Faces.
Returns
A reference to this ShellKey.

◆ SetVertexIndexColorsByList() [2/4]

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

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

Parameters
in_verticesThe indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_indicesThe material indices to set on the vertices.
Returns
A reference to this ShellKey.

◆ SetVertexIndexColorsByList() [3/4]

HPS.ShellKey HPS.ShellKey.SetVertexIndexColorsByList ( ulong []  in_vertices,
float  in_index,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_indexThe material index to set on the vertices.
in_apply_toThe shell component the colors should apply to. Defaults to Shell.Component.Faces.
Returns
A reference to this ShellKey.

◆ SetVertexIndexColorsByList() [4/4]

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

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

Parameters
in_verticesThe indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_indexThe material index to set on the vertices.
Returns
A reference to this ShellKey.

◆ SetVertexIndexColorsByRange() [1/4]

HPS.ShellKey HPS.ShellKey.SetVertexIndexColorsByRange ( ulong  in_start,
float []  in_indices,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_indicesThe material indices to set on the vertices for this ShellKey. The size of the array must be such that in_start+in_indices.size()<=point_count for the setting to succeed.
in_apply_toThe shell component the colors should apply to. Defaults to Shell.Component.Faces.
Returns
A reference to this ShellKey.

◆ SetVertexIndexColorsByRange() [2/4]

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

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_indicesThe material indices to set on the vertices for this 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.

◆ SetVertexIndexColorsByRange() [3/4]

HPS.ShellKey HPS.ShellKey.SetVertexIndexColorsByRange ( ulong  in_start,
ulong  in_count,
float  in_index,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_indexThe material index to set on the vertices for this ShellKey.
in_apply_toThe shell component the colors should apply to. Defaults to Shell.Component.Faces.
Returns
A reference to this ShellKey.

◆ SetVertexIndexColorsByRange() [4/4]

HPS.ShellKey HPS.ShellKey.SetVertexIndexColorsByRange ( ulong  in_start,
ulong  in_count,
float  in_index 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_indexThe material index to set on the vertices for this ShellKey.
Returns
A reference to this ShellKey.

◆ SetVertexNormalsByList() [1/2]

HPS.ShellKey HPS.ShellKey.SetVertexNormalsByList ( ulong []  in_vertices,
HPS.Vector []  in_normals 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the normals. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_normalsThe normals to set on the vertices.
Returns
A reference to this ShellKey.

◆ SetVertexNormalsByList() [2/2]

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

Sets a single normal on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to set the normal. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_normalThe normal to set on the vertices.
Returns
A reference to this ShellKey.

◆ SetVertexNormalsByRange() [1/2]

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

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting normals. This value must be such that in_start<point_count for setting to succeed.
in_normalsThe normals to set on the vertices for this 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.

◆ SetVertexNormalsByRange() [2/2]

HPS.ShellKey HPS.ShellKey.SetVertexNormalsByRange ( ulong  in_start,
ulong  in_count,
HPS.Vector  in_normal 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting the normal. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the normal. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_normalThe normal to set on the vertices for this ShellKey.
Returns
A reference to this ShellKey.

◆ SetVertexParametersByList() [1/2]

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

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

Parameters
in_verticesThe indices of the vertices on which to set the texture parameters. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_paramsThe 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_widthThe number of texture parameters per vertex. Defaults to 2.
Returns
A reference to this ShellKey.

◆ SetVertexParametersByList() [2/2]

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

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

Parameters
in_verticesThe indices of the vertices on which to set the texture parameters. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_paramsThe 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.

◆ SetVertexParametersByRange() [1/2]

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

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting texture parameters. This value must be such that in_start<point_count for setting to succeed.
in_paramsThe texture parameters to set on the vertices for this 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_widthThe number of texture parameters per vertex. Defaults to 2.
Returns
A reference to this ShellKey.

◆ SetVertexParametersByRange() [2/2]

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

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting texture parameters. This value must be such that in_start<point_count for setting to succeed.
in_paramsThe texture parameters to set on the vertices for this 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.

◆ SetVertexRGBAColorsByList() [1/4]

HPS.ShellKey HPS.ShellKey.SetVertexRGBAColorsByList ( ulong []  in_vertices,
HPS.RGBAColor []  in_rgba_colors,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgba_colorsThe RGBA colors to set on the vertices.
in_apply_toThe shell component the colors should apply to. Defaults to Shell.Component.Faces.
Returns
A reference to this ShellKey.

◆ SetVertexRGBAColorsByList() [2/4]

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

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

Parameters
in_verticesThe indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgba_colorsThe RGBA colors to set on the vertices.
Returns
A reference to this ShellKey.

◆ SetVertexRGBAColorsByList() [3/4]

HPS.ShellKey HPS.ShellKey.SetVertexRGBAColorsByList ( ulong []  in_vertices,
HPS.RGBAColor  in_rgba_color,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgba_colorThe RGBA color to set on the vertices.
in_apply_toThe shell component the colors should apply to. Defaults to Shell.Component.Faces.
Returns
A reference to this ShellKey.

◆ SetVertexRGBAColorsByList() [4/4]

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

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

Parameters
in_verticesThe indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgba_colorThe RGBA color to set on the vertices.
Returns
A reference to this ShellKey.

◆ SetVertexRGBAColorsByRange() [1/4]

HPS.ShellKey HPS.ShellKey.SetVertexRGBAColorsByRange ( ulong  in_start,
HPS.RGBAColor []  in_rgba_colors,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_rgba_colorsThe RGBA colors to set on the vertices for this 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_toThe shell component the colors should apply to. Defaults to Shell.Component.Faces.
Returns
A reference to this ShellKey.

◆ SetVertexRGBAColorsByRange() [2/4]

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

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_rgba_colorsThe RGBA colors to set on the vertices for this 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.

◆ SetVertexRGBAColorsByRange() [3/4]

HPS.ShellKey HPS.ShellKey.SetVertexRGBAColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.RGBAColor  in_rgba_color,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_rgba_colorThe RGBA color to set on the vertices for this ShellKey.
in_apply_toThe shell component the colors should apply to. Defaults to Shell.Component.Faces.
Returns
A reference to this ShellKey.

◆ SetVertexRGBAColorsByRange() [4/4]

HPS.ShellKey HPS.ShellKey.SetVertexRGBAColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.RGBAColor  in_rgba_color 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_rgba_colorThe RGBA color to set on the vertices for this ShellKey.
Returns
A reference to this ShellKey.

◆ SetVertexRGBColorsByList() [1/4]

HPS.ShellKey HPS.ShellKey.SetVertexRGBColorsByList ( ulong []  in_vertices,
HPS.RGBColor []  in_rgb_colors,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgb_colorsThe RGB colors to set on the vertices.
in_apply_toThe shell component the colors should apply to. Defaults to Shell.Component.Faces.
Returns
A reference to this ShellKey.

◆ SetVertexRGBColorsByList() [2/4]

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

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

Parameters
in_verticesThe indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgb_colorsThe RGB colors to set on the vertices.
Returns
A reference to this ShellKey.

◆ SetVertexRGBColorsByList() [3/4]

HPS.ShellKey HPS.ShellKey.SetVertexRGBColorsByList ( ulong []  in_vertices,
HPS.RGBColor  in_rgb_color,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgb_colorThe RGB color to set on the vertices.
in_apply_toThe shell component the colors should apply to. Defaults to Shell.Component.Faces.
Returns
A reference to this ShellKey.

◆ SetVertexRGBColorsByList() [4/4]

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

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

Parameters
in_verticesThe indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgb_colorThe RGB color to set on the vertices.
Returns
A reference to this ShellKey.

◆ SetVertexRGBColorsByRange() [1/4]

HPS.ShellKey HPS.ShellKey.SetVertexRGBColorsByRange ( ulong  in_start,
HPS.RGBColor []  in_rgb_colors,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_rgb_colorsThe RGB colors to set on the vertices for this 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_toThe shell component the colors should apply to. Defaults to Shell.Component.Faces.
Returns
A reference to this ShellKey.

◆ SetVertexRGBColorsByRange() [2/4]

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

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_rgb_colorsThe RGB colors to set on the vertices for this 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.

◆ SetVertexRGBColorsByRange() [3/4]

HPS.ShellKey HPS.ShellKey.SetVertexRGBColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.RGBColor  in_rgb_color,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_rgb_colorThe RGB color to set on the vertices for this ShellKey.
in_apply_toThe shell component the colors should apply to. Defaults to Shell.Component.Faces.
Returns
A reference to this ShellKey.

◆ SetVertexRGBColorsByRange() [4/4]

HPS.ShellKey HPS.ShellKey.SetVertexRGBColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.RGBColor  in_rgb_color 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_rgb_colorThe RGB color to set on the vertices for this ShellKey.
Returns
A reference to this ShellKey.

◆ SetVertexVisibilitiesByList() [1/2]

HPS.ShellKey HPS.ShellKey.SetVertexVisibilitiesByList ( ulong []  in_vertices,
bool []  in_visibilities 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to set the visibilities. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_visibilitiesThe visibilities to set on the vertices.
Returns
A reference to this ShellKey.

◆ SetVertexVisibilitiesByList() [2/2]

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

Sets a single visibility on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to set the visibility. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_visibilityThe visibility to set on the vertices.
Returns
A reference to this ShellKey.

◆ SetVertexVisibilitiesByRange() [1/2]

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

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting visibilities. This value must be such that in_start<point_count for setting to succeed.
in_visibilitiesThe visibilities to set on the vertices for this 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.

◆ SetVertexVisibilitiesByRange() [2/2]

HPS.ShellKey HPS.ShellKey.SetVertexVisibilitiesByRange ( ulong  in_start,
ulong  in_count,
bool  in_visibility 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start setting the visibility. This value must be such that in_start<point_count for setting to succeed.
in_countThe number of vertices on which to set the visibility. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_visibilityThe visibility to set on the vertices for this ShellKey.
Returns
A reference to this ShellKey.

◆ Show()

void HPS.ShellKey.Show ( out HPS.ShellKit  out_kit)
inline

Copy the contents of this ShellKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this ShellKey.

◆ ShowEdgeColors()

bool HPS.ShellKey.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 
)
inline

Sets edge colors on a selection of arbitrary edges.

Parameters
out_vertices1The vertex indices that correspond to the start position of each edge for which the visibilities are being changed.
out_vertices2The vertex indices that correspond to the end position of each edge for which the visibilities are being changed.
out_typesThe types of edge colors for each edge.
out_rgb_colorsThe 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_indicesThe 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 ShellKey.

◆ ShowEdgeColorsByList()

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

Sets edge colors on a selection of arbitrary edges.

Parameters
in_vertices1The 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_vertices2The 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_typesThe types of edge colors for each edge.
out_rgb_colorsThe 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_indicesThe 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 ShellKey.

◆ ShowEdgeVisibilitiesByList()

bool HPS.ShellKey.ShowEdgeVisibilitiesByList ( ulong []  in_vertices1,
ulong []  in_vertices2,
out bool []  out_validities,
out bool []  out_visibilities 
)
inline

Shows all the edge visibilities on this ShellKey.

Parameters
in_vertices1The 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_vertices2The 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_validitiesThe 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_visibilitiesThe 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()

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

Shows the face colors on ShellKey.

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

◆ ShowFaceColorsByList()

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

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

Parameters
in_facesThe indices of the faces on which to show the colors. Each index in the array must be such that in_faces[i]<face_count for showing to succeed.
out_typesThe types of face colors for each face at the specified index. If a face at a specified index does not have a face color set, the entry in this array will be Material.Type.None.
out_rgb_colorsThe RGB colors for each face at the specified index. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor.
out_indicesThe material indices for each face at the specified index. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
Returns
true if any specified face had a face color set, false otherwise.

◆ ShowFaceColorsByRange()

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

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

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

◆ ShowFacelist()

bool HPS.ShellKey.ShowFacelist ( out int []  out_facelist)
inline

Show the face list for this ShellKey.

Parameters
out_facelistThe face list for this ShellKey.
Returns
true if face list was set, false otherwise.

◆ ShowFaceNormals()

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

Shows all the face normals for this ShellKey.

Parameters
out_validitiesThe validities of the normals for each face. If a face had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normalsThe face normals for each face. out_normals[i] is only valid if out_validities[i] is true.
Returns
true if any face had a face normal set, false otherwise.

◆ ShowFaceNormalsByList()

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

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

Parameters
in_facesThe indices of the faces on which to show the normals. Each index in the array must be such that in_faces[i]<face_count for showing to succeed.
out_validitiesThe validities of the normals for each face at the specified index. If a face at a specified index had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normalsThe face normals for each face at the specified index. out_normals[i] is only valid if out_validities[i] is true.
Returns
true if any specified face had a face normal set, false otherwise.

◆ ShowFaceNormalsByRange()

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

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

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

◆ ShowFaceVisibilities()

bool HPS.ShellKey.ShowFaceVisibilities ( out bool []  out_validities,
out bool []  out_visibilities 
)
inline

Shows all the face visibilities on this ShellKey.

Parameters
out_validitiesThe validities of the visibilities for each face. If a face had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe face visibilities for each face. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any face had a face visibility set, false otherwise.

◆ ShowFaceVisibilitiesByList()

bool HPS.ShellKey.ShowFaceVisibilitiesByList ( ulong []  in_faces,
out bool []  out_validities,
out bool []  out_visibilities 
)
inline

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

Parameters
in_facesThe indices of the faces on which to show the normals. Each index in the array must be such that in_faces[i]<face_count for showing to succeed.
out_validitiesThe validities of the normals for each face at the specified index. If a face at a specified index had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe face visibilities for each face at the specified index. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any specified face had a face visibility set, false otherwise.

◆ ShowFaceVisibilitiesByRange()

bool HPS.ShellKey.ShowFaceVisibilitiesByRange ( ulong  in_start,
ulong  in_count,
out bool []  out_validities,
out bool []  out_visibilities 
)
inline

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

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

◆ ShowMaterialMapping()

bool HPS.ShellKey.ShowMaterialMapping ( out HPS.MaterialMappingKit  out_kit)
inline

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

Parameters
out_kitThe material mappings set on this ShellKey.
Returns
true if material mappings were set, false otherwise.

◆ ShowNetFaceNormalsByList()

bool HPS.ShellKey.ShowNetFaceNormalsByList ( ulong []  in_faces,
out HPS.Vector []  out_normals 
)
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_facesThe 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_normalsThe face normals for each face at the specified index.
Returns
true if no errors were encountered, false otherwise.

◆ ShowNetFaceNormalsByRange()

bool HPS.ShellKey.ShowNetFaceNormalsByRange ( ulong  in_start,
ulong  in_count,
out HPS.Vector []  out_normals 
)
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_startThe 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_countThe number of normals to show. This value must be such that in_start+in_count<=face_count for the showing to succeed.
out_normalsThe face normals for each face in the specified range.
Returns
true if no errors were encountered, false otherwise.

◆ ShowNetVertexNormals() [1/2]

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

Shows the all net vertex normals on this ShellKey.

Parameters
out_normalsThe vertex normals for each vertex.
in_polygon_handednessThe polygon handedness to assume when returning normals. Defaults to None. Specifying no handedness when requesting net normals, will return the normals using the handedness used internally by Visualize for this particular shell. When specifying a handedness, only normals which were implicitly calculated by Visualize will be flipped to conform to the requested handedness. User specified normals will be left untouched.
Returns
true if no errors were encountered, false otherwise.

◆ ShowNetVertexNormals() [2/2]

bool HPS.ShellKey.ShowNetVertexNormals ( out HPS.Vector []  out_normals)
inline

Shows the all net vertex normals on this ShellKey.

Parameters
out_normalsThe vertex normals for each vertex.
Returns
true if no errors were encountered, false otherwise.

◆ ShowNetVertexNormalsByRange() [1/2]

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

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

Parameters
in_startThe 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_countThe number of normals to show. This value must be such that in_start+in_count<=point_count for the showing to succeed.
out_normalsThe vertex normals for each vertex in the specified range.
in_polygon_handednessThe polygon handedness to assume when returning normals. Defaults to None. Specifying no handedness when requesting net normals, will return the normals using the handedness used internally by Visualize for this particular shell. When specifying a handedness, only normals which were implicitly calculated by Visualize will be flipped to conform to the requested handedness. User specified normals will be left untouched.
Returns
true if no errors were encountered, false otherwise.

◆ ShowNetVertexNormalsByRange() [2/2]

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

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

Parameters
in_startThe 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_countThe number of normals to show. This value must be such that in_start+in_count<=point_count for the showing to succeed.
out_normalsThe vertex normals for each vertex in the specified range.
Returns
true if no errors were encountered, false otherwise.

◆ ShowPoints()

bool HPS.ShellKey.ShowPoints ( out HPS.Point []  out_points)
inline

Show the points for this ShellKey.

Parameters
out_pointsThe points for this ShellKey.
Returns
true if points were set, false otherwise.

◆ ShowPointsByList()

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

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

Parameters
in_indicesThe list of point indices to show.
out_pointsThe requested points for this ShellKey.
Returns
true if all requested points were set, false otherwise.

◆ ShowPointsByRange()

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

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

Parameters
in_start_indexThe first point to show.
in_countThe number of points to show.
out_pointsThe requested points for this ShellKey.
Returns
true if all requested points were set, false otherwise.

◆ ShowTristrips() [1/2]

bool HPS.ShellKey.ShowTristrips ( out int []  out_tristrips)
inline

Show the tristrips list for this ShellKey.

Parameters
out_tristripsThe tristrip list for this ShellKey.
Returns
true if tristrips list was set, false otherwise.

◆ ShowTristrips() [2/2]

bool HPS.ShellKey.ShowTristrips ( out int []  out_tristrips,
out int []  out_face_indices 
)
inline

Show the tristrips list for this ShellKey.

Parameters
out_tristripsThe tristrip list for this ShellKey.
out_face_indicesThe corresponding face indices for each triangle in the tristrip list.
Returns
true if tristrips list was set, false otherwise.

◆ ShowVertexColors()

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

Shows all the vertex colors on the specified shell component.

Parameters
in_apply_toThe shell component the colors should apply to.
out_typesThe types of vertex colors for each vertex. If a vertex does not have a vertex color set for the specified shell component, the entry in this array will be Material.Type.None.
out_rgb_colorsThe RGB colors for each vertex. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor.
out_rgba_colorsThe RGBA colors for each vertex. out_rgba_colors[i] is only valid if out_types[i] is Material.Type.RGBAColor.
out_indicesThe material indices for each vertex. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
Returns
true if any vertex colors were shown, false otherwise.

◆ ShowVertexColorsByList()

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

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

Parameters
in_verticesThe indices of the vertices on which to show the colors. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed.
in_apply_toThe shell component the colors should apply to.
out_typesThe types of vertex colors for each vertex at the specified index. If a vertex at a specified index does not have a vertex color set for the specified component, the entry in this array will be Material.Type.None.
out_rgb_colorsThe RGB colors for each vertex at the specified index. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor.
out_rgba_colorsThe RGBA colors for each vertex at the specified index. out_rgba_colors[i] is only valid if out_types[i] is Material.Type.RGBAColor.
out_indicesThe material indices for each vertex at the specified index. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
Returns
true if any specified vertex had a vertex color on the specified component set, false otherwise.

◆ ShowVertexColorsByRange()

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

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

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

◆ ShowVertexNormals()

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

Shows all the vertex normals on this ShellKey.

Parameters
out_validitiesThe validities of the normals for each vertex. If a vertex had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normalsThe vertex normals for each vertex. out_normals[i] is only valid if out_validities[i] is true.
Returns
true if any vertex normals were shown, false otherwise.

◆ ShowVertexNormalsByList()

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

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

Parameters
in_verticesThe indices of the vertices on which to show the normals. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed.
out_validitiesThe validities of the normals for each vertex at the specified index. If a vertex at a specified index had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normalsThe vertex normals for each vertex at the specified index. out_normals[i] is only valid if out_validities[i] is true.
Returns
true if any specified vertex had a vertex normal set, false otherwise.

◆ ShowVertexNormalsByRange()

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

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

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

◆ ShowVertexParameters() [1/2]

bool HPS.ShellKey.ShowVertexParameters ( out bool []  out_validities,
out float []  out_params 
)
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_validitiesThe validities of the texture parameters for each vertex. If a vertex had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_paramsThe texture parameters for each vertex. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
Returns
true if any vertex had a texture parameter set, false otherwise.

◆ ShowVertexParameters() [2/2]

bool HPS.ShellKey.ShowVertexParameters ( out bool []  out_validities,
out float []  out_params,
out ulong  out_param_width 
)
inline

Shows the texture parameters for all of the vertices on this ShellKey.

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

◆ ShowVertexParametersByList() [1/2]

bool HPS.ShellKey.ShowVertexParametersByList ( ulong []  in_vertices,
out bool []  out_validities,
out float []  out_params 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to show the texture parameters. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed.
out_validitiesThe validities of the texture parameters for each vertex at the specified index. If a vertex at a specified index had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_paramsThe texture parameters for each vertex at the specified index. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
Returns
true if any specified vertex had a texture parameter set, false otherwise.

◆ ShowVertexParametersByList() [2/2]

bool HPS.ShellKey.ShowVertexParametersByList ( ulong []  in_vertices,
out bool []  out_validities,
out float []  out_params,
out ulong  out_param_width 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to show the texture parameters. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed.
out_validitiesThe validities of the texture parameters for each vertex at the specified index. If a vertex at a specified index had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_paramsThe texture parameters for each vertex at the specified index. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
out_param_widthThe number of texture parameters per vertex.
Returns
true if any specified vertex had a texture parameter set, false otherwise.

◆ ShowVertexParametersByRange() [1/2]

bool HPS.ShellKey.ShowVertexParametersByRange ( ulong  in_start,
ulong  in_count,
out bool []  out_validities,
out float []  out_params 
)
inline

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

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

◆ ShowVertexParametersByRange() [2/2]

bool HPS.ShellKey.ShowVertexParametersByRange ( ulong  in_start,
ulong  in_count,
out bool []  out_validities,
out float []  out_params,
out ulong  out_param_width 
)
inline

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

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

◆ ShowVertexVisibilities()

bool HPS.ShellKey.ShowVertexVisibilities ( out bool []  out_validities,
out bool []  out_visibilities 
)
inline

Shows all the vertex visibilities on this ShellKey.

Parameters
out_validitiesThe validities of the visibilities for each vertex. If a vertex had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe vertex visibilities for each vertex. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any vertex had a vertex visibility set, false otherwise.

◆ ShowVertexVisibilitiesByList()

bool HPS.ShellKey.ShowVertexVisibilitiesByList ( ulong []  in_vertices,
out bool []  out_validities,
out bool []  out_visibilities 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to show the normals. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed.
out_validitiesThe validities of the normals for each vertex at the specified index. If a vertex at a specified index had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilitiesThe vertex visibilities for each vertex at the specified index. out_visibilities[i] is only valid if out_validities[i] is true.
Returns
true if any specified vertex had a vertex visibility set, false otherwise.

◆ ShowVertexVisibilitiesByRange()

bool HPS.ShellKey.ShowVertexVisibilitiesByRange ( ulong  in_start,
ulong  in_count,
out bool []  out_validities,
out bool []  out_visibilities 
)
inline

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

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

◆ UnsetEdgeColors()

HPS.ShellKey HPS.ShellKey.UnsetEdgeColors ( )
inline

Unsets edge colors on all edges.

Returns
A reference to this ShellKey.

◆ UnsetEdgeColorsByList()

HPS.ShellKey HPS.ShellKey.UnsetEdgeColorsByList ( ulong []  in_vertices1,
ulong []  in_vertices2 
)
inline

Unsets edge colors on a selection of arbitrary edges.

Parameters
in_vertices1The 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_vertices2The 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 ShellKey.

◆ UnsetEdgeEverything()

HPS.ShellKey HPS.ShellKey.UnsetEdgeEverything ( )
inline

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

Returns
A reference to this ShellKey.

◆ UnsetEdgeVisibilities()

HPS.ShellKey HPS.ShellKey.UnsetEdgeVisibilities ( )
inline

Removes all vertex visibilities.

Returns
A reference to this ShellKey.

◆ UnsetEdgeVisibilitiesByList()

HPS.ShellKey HPS.ShellKey.UnsetEdgeVisibilitiesByList ( ulong []  in_vertices1,
ulong []  in_vertices2 
)
inline

Unsets edge visibilities on a selection of arbitrary edges.

Parameters
in_vertices1The 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_vertices2The 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 ShellKey.

◆ UnsetEverything()

HPS.ShellKey HPS.ShellKey.UnsetEverything ( )
inline

Removes all settings from this ShellKey.

Returns
A reference to this ShellKey.

◆ UnsetFaceColors()

HPS.ShellKey HPS.ShellKey.UnsetFaceColors ( )
inline

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

Returns
A reference to this ShellKey.

◆ UnsetFaceColorsByRange()

HPS.ShellKey HPS.ShellKey.UnsetFaceColorsByRange ( ulong  in_start,
ulong  in_count 
)
inline

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

Parameters
in_startThe offset into the faces for this ShellKey at which to start removing colors. This value must be such that in_start<face_count for removal to succeed.
in_countThe number of face colors to 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.

◆ UnsetFaceEverything()

HPS.ShellKey HPS.ShellKey.UnsetFaceEverything ( )
inline

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

Returns
A reference to this ShellKey.

◆ UnsetFacelist()

HPS.ShellKey HPS.ShellKey.UnsetFacelist ( )
inline

Removes the face list for this ShellKey.

Returns
A reference to this ShellKey.

◆ UnsetFaceNormals()

HPS.ShellKey HPS.ShellKey.UnsetFaceNormals ( )
inline

Removes all face normals.

Returns
A reference to this ShellKey.

◆ UnsetFaceNormalsByList()

HPS.ShellKey HPS.ShellKey.UnsetFaceNormalsByList ( ulong []  in_vertices)
inline

Removes the face normals on a selection of arbitrary faces.

Returns
A reference to this ShellKey.

◆ UnsetFaceNormalsByRange()

HPS.ShellKey HPS.ShellKey.UnsetFaceNormalsByRange ( ulong  in_start,
ulong  in_count 
)
inline

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

Parameters
in_startThe offset into the faces for this ShellKey at which to start removing normals. This value must be such that in_start<face_count for removal to succeed.
in_countThe number of face normals to 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.

◆ UnsetFaceVisibilities()

HPS.ShellKey HPS.ShellKey.UnsetFaceVisibilities ( )
inline

Removes all face visibilities.

Returns
A reference to this ShellKey.

◆ UnsetFaceVisibilitiesByRange()

HPS.ShellKey HPS.ShellKey.UnsetFaceVisibilitiesByRange ( ulong  in_start,
ulong  in_count 
)
inline

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

Parameters
in_startThe offset into the faces for this ShellKey at which to start removing visibilities. This value must be such that in_start<face_count for removal to succeed.
in_countThe number of face visibilities to 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.

◆ UnsetMaterialMapping()

HPS.ShellKey HPS.ShellKey.UnsetMaterialMapping ( )
inline

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

Returns
A reference to this ShellKey.

◆ UnsetPoints()

HPS.ShellKey HPS.ShellKey.UnsetPoints ( )
inline

Removes the points for this ShellKey.

Returns
A reference to this ShellKey.

◆ UnsetTristrips()

HPS.ShellKey HPS.ShellKey.UnsetTristrips ( )
inline

Removes the tristrips list for this ShellKey.

Returns
A reference to this ShellKey.

◆ UnsetVertexColors() [1/2]

HPS.ShellKey HPS.ShellKey.UnsetVertexColors ( )
inline

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

Returns
A reference to this ShellKey.

◆ UnsetVertexColors() [2/2]

HPS.ShellKey HPS.ShellKey.UnsetVertexColors ( HPS.Shell.Component  in_apply_to)
inline

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

Parameters
in_apply_toThe shell component for which to remove the colors.
Returns
A reference to this ShellKey.

◆ UnsetVertexColorsByList() [1/2]

HPS.ShellKey HPS.ShellKey.UnsetVertexColorsByList ( ulong []  in_vertices)
inline

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

Parameters
in_verticesThe indices of the vertices on which to remove the colors. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.
Returns
A reference to this ShellKey.

◆ UnsetVertexColorsByList() [2/2]

HPS.ShellKey HPS.ShellKey.UnsetVertexColorsByList ( ulong []  in_vertices,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_verticesThe indices of the vertices on which to remove the colors. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.
in_apply_toThe shell component for which to remove the colors.
Returns
A reference to this ShellKey.

◆ UnsetVertexColorsByRange() [1/2]

HPS.ShellKey HPS.ShellKey.UnsetVertexColorsByRange ( ulong  in_start,
ulong  in_count 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start removing colors. This value must be such that in_start<point_count for removal to succeed.
in_countThe number of vertex colors to 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.

◆ UnsetVertexColorsByRange() [2/2]

HPS.ShellKey HPS.ShellKey.UnsetVertexColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.Shell.Component  in_apply_to 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start removing colors. This value must be such that in_start<point_count for removal to succeed.
in_countThe number of vertex colors to remove for this ShellKey. This value must be such that in_start+in_count<=point_count for the removal to succeed.
in_apply_toThe shell component for which to remove the colors.
Returns
A reference to this ShellKey.

◆ UnsetVertexEverything()

HPS.ShellKey HPS.ShellKey.UnsetVertexEverything ( )
inline

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

Returns
A reference to this ShellKey.

◆ UnsetVertexNormals()

HPS.ShellKey HPS.ShellKey.UnsetVertexNormals ( )
inline

Removes all vertex normals.

Returns
A reference to this ShellKey.

◆ UnsetVertexNormalsByList()

HPS.ShellKey HPS.ShellKey.UnsetVertexNormalsByList ( ulong []  in_vertices)
inline

Removes the vertex normals on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to remove the normals. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.
Returns
A reference to this ShellKey.

◆ UnsetVertexNormalsByRange()

HPS.ShellKey HPS.ShellKey.UnsetVertexNormalsByRange ( ulong  in_start,
ulong  in_count 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start removing normals. This value must be such that in_start<point_count for removal to succeed.
in_countThe number of vertex normals to 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.

◆ UnsetVertexParameters()

HPS.ShellKey HPS.ShellKey.UnsetVertexParameters ( )
inline

Removes all texture parameters.

Returns
A reference to this ShellKey.

◆ UnsetVertexParametersByList()

HPS.ShellKey HPS.ShellKey.UnsetVertexParametersByList ( ulong []  in_vertices)
inline

Removes the texture parameters on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to remove the texture parameters. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.
Returns
A reference to this ShellKey.

◆ UnsetVertexParametersByRange()

HPS.ShellKey HPS.ShellKey.UnsetVertexParametersByRange ( ulong  in_start,
ulong  in_count 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start removing texture parameters. This value must be such that in_start<point_count for removal to succeed.
in_countThe number of texture parameters to 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.

◆ UnsetVertexVisibilities()

HPS.ShellKey HPS.ShellKey.UnsetVertexVisibilities ( )
inline

Removes all vertex visibilities.

Returns
A reference to this ShellKey.

◆ UnsetVertexVisibilitiesByList()

HPS.ShellKey HPS.ShellKey.UnsetVertexVisibilitiesByList ( ulong []  in_vertices)
inline

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to remove the visibilities. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.
Returns
A reference to this ShellKey.

◆ UnsetVertexVisibilitiesByRange()

HPS.ShellKey HPS.ShellKey.UnsetVertexVisibilitiesByRange ( ulong  in_start,
ulong  in_count 
)
inline

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

Parameters
in_startThe offset into the vertices for this ShellKey at which to start removing visibilities. This value must be such that in_start<point_count for removal to succeed.
in_countThe number of vertex visibilities to 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