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

Public Member Functions

void Consume (HPS.CylinderKit in_kit)
 
 CylinderKey ()
 
 CylinderKey (HPS.Key in_that)
 
 CylinderKey (HPS.CylinderKey in_that)
 
override void Dispose ()
 
HPS.CylinderKey EditPointsByDeletion (ulong in_offset, ulong in_count)
 
HPS.CylinderKey EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points)
 
HPS.CylinderKey EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)
 
HPS.CylinderKey EditRadiiByDeletion (ulong in_offset, ulong in_count)
 
HPS.CylinderKey EditRadiiByInsertion (ulong in_offset, float[] in_radii)
 
HPS.CylinderKey EditRadiiByReplacement (ulong in_offset, float[] in_radii)
 
ulong GetPointCount ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.CylinderKit in_kit)
 
HPS.CylinderKey SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKey SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices)
 
HPS.CylinderKey SetVertexIndexColorsByList (ulong[] in_vertices, float in_index, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKey SetVertexIndexColorsByList (ulong[] in_vertices, float in_index)
 
HPS.CylinderKey SetVertexIndexColorsByRange (ulong in_start, float[] in_indices, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKey SetVertexIndexColorsByRange (ulong in_start, float[] in_indices)
 
HPS.CylinderKey SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKey SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index)
 
HPS.CylinderKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors)
 
HPS.CylinderKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color)
 
HPS.CylinderKey SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKey SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors)
 
HPS.CylinderKey SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKey SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color)
 
void Show (out HPS.CylinderKit out_kit)
 
bool ShowCaps (out HPS.Cylinder.Capping out_caps)
 
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 ShowRadii (out float[] out_radii)
 
bool ShowVertexColors (HPS.Cylinder.Component in_apply_to, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)
 
bool ShowVertexColorsByList (ulong[] in_vertices, HPS.Cylinder.Component in_apply_to, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)
 
bool ShowVertexColorsByRange (ulong in_start, ulong in_count, HPS.Cylinder.Component in_apply_to, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)
 
HPS.CylinderKey UnsetVertexColors ()
 
HPS.CylinderKey UnsetVertexColors (HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKey UnsetVertexColorsByList (ulong[] in_vertices)
 
HPS.CylinderKey UnsetVertexColorsByList (ulong[] in_vertices, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKey UnsetVertexColorsByRange (ulong in_start, ulong in_count)
 
HPS.CylinderKey UnsetVertexColorsByRange (ulong in_start, ulong in_count, HPS.Cylinder.Component in_apply_to)
 
- Public Member Functions inherited from HPS.GeometryKey
override void Dispose ()
 
 GeometryKey ()
 
 GeometryKey (HPS.Key in_that)
 
 GeometryKey (HPS.GeometryKey in_that)
 
override HPS.Type ObjectType ()
 
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 void Dispose ()
 
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)
 
override HPS.Type ObjectType ()
 
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.GeometryKey
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Key
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 CylinderKey class is a smart pointer to a database object. It is a handle to a cylinder inserted via SegmentKey.InsertCylinder.

Constructor & Destructor Documentation

◆ CylinderKey() [1/3]

HPS.CylinderKey.CylinderKey ( )
inline

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

◆ CylinderKey() [2/3]

HPS.CylinderKey.CylinderKey ( HPS.Key  in_that)
inline

This constructor creates a CylinderKey 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 Cylinder key. Otherwise the copy will fail and the resulting CylinderKey will be invalid.

◆ CylinderKey() [3/3]

HPS.CylinderKey.CylinderKey ( HPS.CylinderKey  in_that)
inline

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

Parameters
in_thatThe source CylinderKey to copy.

Member Function Documentation

◆ Consume()

void HPS.CylinderKey.Consume ( HPS.CylinderKit  in_kit)
inline

Completely replaces all settings on this CylinderKey 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 CylinderKey.

◆ EditPointsByDeletion()

HPS.CylinderKey HPS.CylinderKey.EditPointsByDeletion ( ulong  in_offset,
ulong  in_count 
)
inline

Removes points from the point list for this CylinderKey.

Parameters
in_offsetThe offset into the point list for the cylinder 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 cylinder. This value must be such that in_offset+in_count<=point_count for the deletion to succeed.
Returns
A reference to this CylinderKey.

◆ EditPointsByInsertion()

HPS.CylinderKey HPS.CylinderKey.EditPointsByInsertion ( ulong  in_offset,
HPS.Point []  in_points 
)
inline

Adds points to the point list for this CylinderKey.

Parameters
in_offsetThe offset into the point list for the cylinder 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 CylinderKey.

◆ EditPointsByReplacement()

HPS.CylinderKey HPS.CylinderKey.EditPointsByReplacement ( ulong  in_offset,
HPS.Point []  in_points 
)
inline

Replaces points in the point list for this CylinderKey.

Parameters
in_offsetThe offset into the point list for the cylidner 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 CylinderKey.

◆ EditRadiiByDeletion()

HPS.CylinderKey HPS.CylinderKey.EditRadiiByDeletion ( ulong  in_offset,
ulong  in_count 
)
inline

Removes radii from the radius list for this CylinderKey.

Parameters
in_offsetThe offset into the radius list for the cylinder at which to start removing radii. This value must be such that in_offset<radius_count for deletion to succeed.
in_countThe number of radii to delete from the radius list for the cylinder. This value must be such that in_offset+in_count<=radius_count for the deletion to succeed.
Returns
A reference to this CylinderKey.

◆ EditRadiiByInsertion()

HPS.CylinderKey HPS.CylinderKey.EditRadiiByInsertion ( ulong  in_offset,
float []  in_radii 
)
inline

Adds radii to the radius list for this CylinderKey.

Parameters
in_offsetThe offset into the radius list for the cylinder at which to insert radii. This value must be such that in_offset<radius_count for insertion to succeed.
in_radiiThe radii to insert into the radius list at the specified offset.
Returns
A reference to this CylinderKey.

◆ EditRadiiByReplacement()

HPS.CylinderKey HPS.CylinderKey.EditRadiiByReplacement ( ulong  in_offset,
float []  in_radii 
)
inline

Replaces radii in the radius list for this CylinderKey.

Parameters
in_offsetThe offset into the radius list for the cylidner at which to start replacing radii. This value must be such that in_offset<radius_count for replacement to succeed.
in_radiiThe radii to use to replace those in the radius list at the specified offset. This size of the array must be such that in_offset+in_points.size()<=radius_count for the replacement to succeed.
Returns
A reference to this CylinderKey.

◆ GetPointCount()

ulong HPS.CylinderKey.GetPointCount ( )
inline

Retrieves the number of points in this cylinder.

Returns
The number of points in this cylinder.

◆ ObjectType()

override HPS.Type HPS.CylinderKey.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.Object.

◆ Set()

void HPS.CylinderKey.Set ( HPS.CylinderKit  in_kit)
inline

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

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

◆ SetVertexIndexColorsByList() [1/4]

HPS.CylinderKey HPS.CylinderKey.SetVertexIndexColorsByList ( ulong []  in_vertices,
float []  in_indices,
HPS.Cylinder.Component  in_apply_to 
)
inline

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_indicesThe material indices to set on the vertices.
in_apply_toThe cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Returns
A reference to this CylinderKey.

◆ SetVertexIndexColorsByList() [2/4]

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

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_indicesThe material indices to set on the vertices.
Returns
A reference to this CylinderKey.

◆ SetVertexIndexColorsByList() [3/4]

HPS.CylinderKey HPS.CylinderKey.SetVertexIndexColorsByList ( ulong []  in_vertices,
float  in_index,
HPS.Cylinder.Component  in_apply_to 
)
inline

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_indexThe material index to set on the vertices.
in_apply_toThe cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Returns
A reference to this CylinderKey.

◆ SetVertexIndexColorsByList() [4/4]

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

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_indexThe material index to set on the vertices.
Returns
A reference to this CylinderKey.

◆ SetVertexIndexColorsByRange() [1/4]

HPS.CylinderKey HPS.CylinderKey.SetVertexIndexColorsByRange ( ulong  in_start,
float []  in_indices,
HPS.Cylinder.Component  in_apply_to 
)
inline

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

Parameters
in_startThe offset into the vertices for this CylinderKey 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 CylinderKey. The size of the array must be such that in_start+in_indices.size()<=point_count for the setting to succeed.
in_apply_toThe cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Returns
A reference to this CylinderKey.

◆ SetVertexIndexColorsByRange() [2/4]

HPS.CylinderKey HPS.CylinderKey.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 cylinder component.

Parameters
in_startThe offset into the vertices for this CylinderKey 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 CylinderKey. 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 CylinderKey.

◆ SetVertexIndexColorsByRange() [3/4]

HPS.CylinderKey HPS.CylinderKey.SetVertexIndexColorsByRange ( ulong  in_start,
ulong  in_count,
float  in_index,
HPS.Cylinder.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 cylinder component.

Parameters
in_startThe offset into the vertices for this CylinderKey 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 CylinderKey.
in_apply_toThe cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Returns
A reference to this CylinderKey.

◆ SetVertexIndexColorsByRange() [4/4]

HPS.CylinderKey HPS.CylinderKey.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 cylinder component.

Parameters
in_startThe offset into the vertices for this CylinderKey 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 CylinderKey.
Returns
A reference to this CylinderKey.

◆ SetVertexRGBColorsByList() [1/4]

HPS.CylinderKey HPS.CylinderKey.SetVertexRGBColorsByList ( ulong []  in_vertices,
HPS.RGBColor []  in_rgb_colors,
HPS.Cylinder.Component  in_apply_to 
)
inline

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_rgb_colorsThe RGB colors to set on the vertices.
in_apply_toThe cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Returns
A reference to this CylinderKey.

◆ SetVertexRGBColorsByList() [2/4]

HPS.CylinderKey HPS.CylinderKey.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 cylinder component.

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_rgb_colorsThe RGB colors to set on the vertices.
Returns
A reference to this CylinderKey.

◆ SetVertexRGBColorsByList() [3/4]

HPS.CylinderKey HPS.CylinderKey.SetVertexRGBColorsByList ( ulong []  in_vertices,
HPS.RGBColor  in_rgb_color,
HPS.Cylinder.Component  in_apply_to 
)
inline

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_rgb_colorThe RGB color to set on the vertices.
in_apply_toThe cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Returns
A reference to this CylinderKey.

◆ SetVertexRGBColorsByList() [4/4]

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

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component.

Parameters
in_verticesThe indices of the vertices on which to set the colors.
in_rgb_colorThe RGB color to set on the vertices.
Returns
A reference to this CylinderKey.

◆ SetVertexRGBColorsByRange() [1/4]

HPS.CylinderKey HPS.CylinderKey.SetVertexRGBColorsByRange ( ulong  in_start,
HPS.RGBColor []  in_rgb_colors,
HPS.Cylinder.Component  in_apply_to 
)
inline

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

Parameters
in_startThe offset into the vertices for this CylinderKey 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 CylinderKey. 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 Cylinder.Component.Faces.
Returns
A reference to this CylinderKey.

◆ SetVertexRGBColorsByRange() [2/4]

HPS.CylinderKey HPS.CylinderKey.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 cylinder component.

Parameters
in_startThe offset into the vertices for this CylinderKey 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 CylinderKey. 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 CylinderKey.

◆ SetVertexRGBColorsByRange() [3/4]

HPS.CylinderKey HPS.CylinderKey.SetVertexRGBColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.RGBColor  in_rgb_color,
HPS.Cylinder.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 cylinder component.

Parameters
in_startThe offset into the vertices for this CylinderKey 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 CylinderKey.
in_apply_toThe cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Returns
A reference to this CylinderKey.

◆ SetVertexRGBColorsByRange() [4/4]

HPS.CylinderKey HPS.CylinderKey.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 cylinder component.

Parameters
in_startThe offset into the vertices for this CylinderKey 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 CylinderKey.
Returns
A reference to this CylinderKey.

◆ Show()

void HPS.CylinderKey.Show ( out HPS.CylinderKit  out_kit)
inline

Copy the contents of this CylinderKey into the specified kit.

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

◆ ShowCaps()

bool HPS.CylinderKey.ShowCaps ( out HPS.Cylinder.Capping  out_caps)
inline

Show the capping for this CylinderKey.

Parameters
out_capsThe capping for this CylinderKey.
Returns
true if a capping was set, false otherwise.

◆ ShowPoints()

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

Show the points for this CylinderKey.

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

◆ ShowPointsByList()

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

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

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

◆ ShowPointsByRange()

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

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

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

◆ ShowRadii()

bool HPS.CylinderKey.ShowRadii ( out float []  out_radii)
inline

Show the radii for this CylinderKey.

Parameters
out_radiiThe radii for this CylinderKey.
Returns
true if radii were set, false otherwise.

◆ ShowVertexColors()

bool HPS.CylinderKey.ShowVertexColors ( HPS.Cylinder.Component  in_apply_to,
out HPS.Material.Type []  out_types,
out HPS.RGBColor []  out_rgb_colors,
out float []  out_indices 
)
inline

Shows all the vertex colors of the specified cylinder component.

Parameters
in_apply_toThe cylinder 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 cylinder 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_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.CylinderKey.ShowVertexColorsByList ( ulong []  in_vertices,
HPS.Cylinder.Component  in_apply_to,
out HPS.Material.Type []  out_types,
out HPS.RGBColor []  out_rgb_colors,
out float []  out_indices 
)
inline

Shows the vertex colors on a selection of arbitrary vertices which apply to the specified cylinder 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], and out_indices[i], correspond to the vertex at index in_vertices[i].

Parameters
in_verticesThe indices of the vertices on which to show the colors.
in_apply_toThe cylinder 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_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.CylinderKey.ShowVertexColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.Cylinder.Component  in_apply_to,
out HPS.Material.Type []  out_types,
out HPS.RGBColor []  out_rgb_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 cylinder component.

Parameters
in_startThe offset into the vertices for this CylinderKey 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 showing to succeed.
in_apply_toThe cylinder 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 cylinder 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_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.

◆ UnsetVertexColors() [1/2]

HPS.CylinderKey HPS.CylinderKey.UnsetVertexColors ( )
inline

Removes all vertex colors (RGB colors or material indices) for all cylinder components.

Returns
A reference to this CylinderKey.

◆ UnsetVertexColors() [2/2]

HPS.CylinderKey HPS.CylinderKey.UnsetVertexColors ( HPS.Cylinder.Component  in_apply_to)
inline

Removes all vertex colors (RGB colors or material indices) for the specified cylinder component.

Parameters
in_apply_toThe cylinder component for which to remove the colors.
Returns
A reference to this CylinderKey.

◆ UnsetVertexColorsByList() [1/2]

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

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to remove the visibilities.
Returns
A reference to this CylinderKey.

◆ UnsetVertexColorsByList() [2/2]

HPS.CylinderKey HPS.CylinderKey.UnsetVertexColorsByList ( ulong []  in_vertices,
HPS.Cylinder.Component  in_apply_to 
)
inline

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters
in_verticesThe indices of the vertices on which to remove the visibilities.
in_apply_toThe cylinder component that should be unset.
Returns
A reference to this CylinderKey.

◆ UnsetVertexColorsByRange() [1/2]

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

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

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

◆ UnsetVertexColorsByRange() [2/2]

HPS.CylinderKey HPS.CylinderKey.UnsetVertexColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.Cylinder.Component  in_apply_to 
)
inline

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

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

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