Inheritance diagram for HPS.CylinderKit:
HPS.Kit HPS.Object

Public Member Functions

void Consume (HPS.CylinderKit in_kit)
 
 CylinderKit ()
 
 CylinderKit (HPS.CylinderKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.CylinderKit in_kit)
 
override int GetHashCode ()
 
ulong GetPointCount ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.CylinderKit in_kit)
 
HPS.CylinderKit SetCaps (HPS.Cylinder.Capping in_capping)
 
HPS.CylinderKit SetPoints (HPS.Point[] in_points)
 
HPS.CylinderKit SetPriority (int in_priority)
 
HPS.CylinderKit SetRadii (float[] in_radii)
 
HPS.CylinderKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.CylinderKit SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.CylinderKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
HPS.CylinderKit SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKit SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices)
 
HPS.CylinderKit SetVertexIndexColorsByList (ulong[] in_vertices, float in_index, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKit SetVertexIndexColorsByList (ulong[] in_vertices, float in_index)
 
HPS.CylinderKit SetVertexIndexColorsByRange (ulong in_start, float[] in_indices, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKit SetVertexIndexColorsByRange (ulong in_start, float[] in_indices)
 
HPS.CylinderKit SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKit SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index)
 
HPS.CylinderKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors)
 
HPS.CylinderKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color)
 
HPS.CylinderKit SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKit SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors)
 
HPS.CylinderKit SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKit 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 ShowPriority (out int out_priority)
 
bool ShowRadii (out float[] out_radii)
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 
ulong ShowUserDataCount ()
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 
bool ShowVertexColors (HPS.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.CylinderKit UnsetAllUserData ()
 
HPS.CylinderKit UnsetCaps ()
 
HPS.CylinderKit UnsetEverything ()
 
HPS.CylinderKit UnsetPoints ()
 
HPS.CylinderKit UnsetPriority ()
 
HPS.CylinderKit UnsetRadii ()
 
HPS.CylinderKit UnsetUserData (IntPtr in_index)
 
HPS.CylinderKit UnsetUserData (IntPtr[] in_indices)
 
HPS.CylinderKit UnsetVertexColors ()
 
HPS.CylinderKit UnsetVertexColors (HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKit UnsetVertexColorsByList (ulong[] in_vertices)
 
HPS.CylinderKit UnsetVertexColorsByList (ulong[] in_vertices, HPS.Cylinder.Component in_apply_to)
 
HPS.CylinderKit UnsetVertexColorsByRange (ulong in_start, ulong in_count)
 
HPS.CylinderKit UnsetVertexColorsByRange (ulong in_start, ulong in_count, HPS.Cylinder.Component in_apply_to)
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

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

Protected Member Functions

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

Additional Inherited Members

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

Detailed Description

The CylinderKit class is a user space object. It is a kit analog to a CylinderKey.

Constructor & Destructor Documentation

◆ CylinderKit() [1/2]

HPS.CylinderKit.CylinderKit ( )
inline

The default constructor creates an empty CylinderKit object.

◆ CylinderKit() [2/2]

HPS.CylinderKit.CylinderKit ( HPS.CylinderKit  in_kit)
inline

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

Parameters
in_kitThe source CylinderKit to copy.

Member Function Documentation

◆ Consume()

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

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

Parameters
in_kitThe source CylinderKit to consume.

◆ Empty()

override bool HPS.CylinderKit.Empty ( )
inlinevirtual

Indicates whether this CylinderKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source CylinderKit is equivalent to this CylinderKit.

Parameters
in_kitThe source CylinderKit to compare to this CylinderKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetPointCount()

ulong HPS.CylinderKit.GetPointCount ( )
inline

Retrieves the number of points in this cylinder.

Returns
The number of points in this cylinder.

◆ ObjectType()

override HPS.Type HPS.CylinderKit.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.CylinderKit.Set ( HPS.CylinderKit  in_kit)
inline

Copies the source CylinderKit into this CylinderKit.

Parameters
in_kitThe source CylinderKit to copy.

◆ SetCaps()

HPS.CylinderKit HPS.CylinderKit.SetCaps ( HPS.Cylinder.Capping  in_capping)
inline

Sets the capping for this CylinderKit.

Parameters
in_cappingThe capping for this CylinderKit.
Returns
A reference to this CylinderKit.

◆ SetPoints()

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

Sets the points for this CylinderKit.

Parameters
in_pointsThe points for this CylinderKit.
Returns
A reference to this CylinderKit.

◆ SetPriority()

HPS.CylinderKit HPS.CylinderKit.SetPriority ( int  in_priority)
inline

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

Parameters
in_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.
See also
SubwindowKit.SetPriority()
SubwindowKit.SetRenderingAlgorithm()

◆ SetRadii()

HPS.CylinderKit HPS.CylinderKit.SetRadii ( float []  in_radii)
inline

Sets the radii for this CylinderKit. If the size of the radii array is smaller than the point array, the radii array will be walked repeatedly to determine the radius for all points.

Parameters
in_radiiThe radii for this CylinderKit.
Returns
A reference to this CylinderKit.

◆ SetUserData() [1/3]

HPS.CylinderKit HPS.CylinderKit.SetUserData ( IntPtr  in_index,
ulong  in_bytes,
byte []  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [2/3]

HPS.CylinderKit HPS.CylinderKit.SetUserData ( IntPtr  in_index,
byte []  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [3/3]

HPS.CylinderKit HPS.CylinderKit.SetUserData ( IntPtr []  in_indices,
byte  in_data[][] 
)
inline

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.

◆ SetVertexIndexColorsByList() [1/4]

HPS.CylinderKit HPS.CylinderKit.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. If the sizes of the vertex index and material index arrays are different, the smaller size will be used.

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

◆ SetVertexIndexColorsByList() [2/4]

HPS.CylinderKit HPS.CylinderKit.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. If the sizes of the vertex index and material index arrays are different, the smaller size will be used.

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

◆ SetVertexIndexColorsByList() [3/4]

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

Sets a single material index 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 color.
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 CylinderKit.

◆ SetVertexIndexColorsByList() [4/4]

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

Sets a single material index 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 color.
in_indexThe material index to set on the vertices.
Returns
A reference to this CylinderKit.

◆ SetVertexIndexColorsByRange() [1/4]

HPS.CylinderKit HPS.CylinderKit.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 CylinderKit at which to start setting colors.
in_indicesThe material indices to set on the vertices for this CylinderKit.
in_apply_toThe cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Returns
A reference to this CylinderKit.

◆ SetVertexIndexColorsByRange() [2/4]

HPS.CylinderKit HPS.CylinderKit.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 CylinderKit at which to start setting colors.
in_indicesThe material indices to set on the vertices for this CylinderKit.
Returns
A reference to this CylinderKit.

◆ SetVertexIndexColorsByRange() [3/4]

HPS.CylinderKit HPS.CylinderKit.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 CylinderKit at which to start setting the color.
in_countThe number of vertices on which to set the color.
in_indexThe material index to set on the vertices for this CylinderKit.
in_apply_toThe cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Returns
A reference to this CylinderKit.

◆ SetVertexIndexColorsByRange() [4/4]

HPS.CylinderKit HPS.CylinderKit.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 CylinderKit at which to start setting the color.
in_countThe number of vertices on which to set the color.
in_indexThe material index to set on the vertices for this CylinderKit.
Returns
A reference to this CylinderKit.

◆ SetVertexRGBColorsByList() [1/4]

HPS.CylinderKit HPS.CylinderKit.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. If the sizes of the vertex index array and the color array different, the smaller size will be used.

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

◆ SetVertexRGBColorsByList() [2/4]

HPS.CylinderKit HPS.CylinderKit.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. If the sizes of the vertex index array and the color array different, the smaller size will be used.

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

◆ SetVertexRGBColorsByList() [3/4]

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

Sets a single RGB color 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 color.
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 CylinderKit.

◆ SetVertexRGBColorsByList() [4/4]

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

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

◆ SetVertexRGBColorsByRange() [1/4]

HPS.CylinderKit HPS.CylinderKit.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 CylinderKit at which to start setting colors.
in_rgb_colorsThe RGB colors to set on the vertices for this CylinderKit.
in_apply_toThe cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Returns
A reference to this CylinderKit.

◆ SetVertexRGBColorsByRange() [2/4]

HPS.CylinderKit HPS.CylinderKit.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 CylinderKit at which to start setting colors.
in_rgb_colorsThe RGB colors to set on the vertices for this CylinderKit.
Returns
A reference to this CylinderKit.

◆ SetVertexRGBColorsByRange() [3/4]

HPS.CylinderKit HPS.CylinderKit.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 CylinderKit at which to start setting the color.
in_countThe number of vertices on which to set the color.
in_rgb_colorThe RGB color to set on the vertices for this CylinderKit.
in_apply_toThe cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Returns
A reference to this CylinderKit.

◆ SetVertexRGBColorsByRange() [4/4]

HPS.CylinderKit HPS.CylinderKit.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 CylinderKit at which to start setting the color.
in_countThe number of vertices on which to set the color.
in_rgb_colorThe RGB color to set on the vertices for this CylinderKit.
Returns
A reference to this CylinderKit.

◆ Show()

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

Copies this CylinderKit into the given CylinderKit.

Parameters
out_kitThe CylinderKit to populate with the contents of this CylinderKit.

◆ ShowCaps()

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

Show the capping for this CylinderKit.

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

◆ ShowPoints()

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

Show the points for this CylinderKit.

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

◆ ShowPointsByList()

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

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

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

◆ ShowPointsByRange()

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

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

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

◆ ShowPriority()

bool HPS.CylinderKit.ShowPriority ( out int  out_priority)
inline

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if the setting is valid, false otherwise.

◆ ShowRadii()

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

Show the radii for this CylinderKit.

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

◆ ShowUserData() [1/2]

bool HPS.CylinderKit.ShowUserData ( IntPtr  in_index,
out byte []  out_data 
)
inline

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

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.

◆ ShowUserData() [2/2]

bool HPS.CylinderKit.ShowUserData ( out IntPtr []  out_indices,
out byte  out_data[][] 
)
inline

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn array of all user data set on this kit.
Returns
true if there is user data on this kit, false otherwise.

◆ ShowUserDataCount()

ulong HPS.CylinderKit.ShowUserDataCount ( )
inline

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

◆ ShowUserDataIndices()

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

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

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.

◆ ShowVertexColors()

bool HPS.CylinderKit.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.CylinderKit.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], out_rgba_colors[i], and out_indices[i], correspond to the vertex at index in_vertices[i].

Parameters
in_verticesThe indices of the vertices on which to show the colors.
in_apply_toThe 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.CylinderKit.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 CylinderKit at which to start showing colors.
in_countThe number of colors to show.
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.

◆ UnsetAllUserData()

HPS.CylinderKit HPS.CylinderKit.UnsetAllUserData ( )
inline

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetCaps()

HPS.CylinderKit HPS.CylinderKit.UnsetCaps ( )
inline

Removes the capping for this CylinderKit.

Returns
A reference to this CylinderKit.

◆ UnsetEverything()

HPS.CylinderKit HPS.CylinderKit.UnsetEverything ( )
inline

Removes all settings from the CylinderKit.

Returns
A reference to this CylinderKit.

◆ UnsetPoints()

HPS.CylinderKit HPS.CylinderKit.UnsetPoints ( )
inline

Removes the points for this CylinderKit.

Returns
A reference to this CylinderKit.

◆ UnsetPriority()

HPS.CylinderKit HPS.CylinderKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetRadii()

HPS.CylinderKit HPS.CylinderKit.UnsetRadii ( )
inline

Removes the radii for this CylinderKit.

Returns
A reference to this CylinderKit.

◆ UnsetUserData() [1/2]

HPS.CylinderKit HPS.CylinderKit.UnsetUserData ( IntPtr  in_index)
inline

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

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [2/2]

HPS.CylinderKit HPS.CylinderKit.UnsetUserData ( IntPtr []  in_indices)
inline

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

Parameters
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

◆ UnsetVertexColors() [1/2]

HPS.CylinderKit HPS.CylinderKit.UnsetVertexColors ( )
inline

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

Returns
A reference to this CylinderKit.

◆ UnsetVertexColors() [2/2]

HPS.CylinderKit HPS.CylinderKit.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 CylinderKit.

◆ UnsetVertexColorsByList() [1/2]

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

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

Parameters
in_verticesThe indices of the vertices on which to remove the colors.
Returns
A reference to this CylinderKit.

◆ UnsetVertexColorsByList() [2/2]

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

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

Parameters
in_verticesThe indices of the vertices on which to remove the colors.
in_apply_toThe cylinder component for which to remove the colors.
Returns
A reference to this CylinderKit.

◆ UnsetVertexColorsByRange() [1/2]

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

◆ UnsetVertexColorsByRange() [2/2]

HPS.CylinderKit HPS.CylinderKit.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 CylinderKit at which to start removing colors.
in_countThe number of vertex colors to remove for this CylinderKit.
in_apply_toThe cylinder component for which to remove the colors.
Returns
A reference to this CylinderKit.

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