< Home

< Table of Contents

REFERENCE MANUAL

HPS.CylinderKit Class Reference

The CylinderKit class is a user space object. More...

Inheritance diagram for HPS.CylinderKit:
HPS.Object

Public Member Functions

void Consume (HPS.CylinderKit in_kit)
 Copies the source CylinderKit into this CylinderKit and resets the source kit. More...
 
 CylinderKit ()
 The default constructor creates an empty CylinderKit object. More...
 
 CylinderKit (HPS.CylinderKit in_kit)
 The copy constructor creates a new CylinderKit object that contains the same settings as the source CylinderKit. More...
 
override void Dispose ()
 
override bool Empty ()
 Indicates whether this CylinderKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.CylinderKit in_kit)
 Check if the source CylinderKit is equivalent to this CylinderKit. More...
 
override int GetHashCode ()
 
ulong GetPointCount ()
 Retrieves the number of points in this cylinder. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.CylinderKit in_kit)
 Copies the source CylinderKit into this CylinderKit. More...
 
HPS.CylinderKit SetCaps (HPS.Cylinder.Capping in_capping)
 Sets the capping for this CylinderKit. More...
 
HPS.CylinderKit SetPoints (HPS.Point[] in_points)
 Sets the points for this CylinderKit. More...
 
HPS.CylinderKit SetPriority (int in_priority)
 Assigns a specific drawing priority value to the CylinderKit. More...
 
HPS.CylinderKit SetRadii (float[] in_radii)
 Sets the radii for this CylinderKit. More...
 
HPS.CylinderKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 Sets user data on this kit. More...
 
HPS.CylinderKit SetUserData (IntPtr in_index, byte[] in_data)
 Sets user data on this kit. More...
 
HPS.CylinderKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 Sets user data on this kit. More...
 
HPS.CylinderKit SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices, HPS.Cylinder.Component in_apply_to)
 Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices)
 Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexIndexColorsByList (ulong[] in_vertices, float in_index, HPS.Cylinder.Component in_apply_to)
 Sets a single material index on a selection of arbitrary vertices which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexIndexColorsByList (ulong[] in_vertices, float in_index)
 Sets a single material index on a selection of arbitrary vertices which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexIndexColorsByRange (ulong in_start, float[] in_indices, HPS.Cylinder.Component in_apply_to)
 Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexIndexColorsByRange (ulong in_start, float[] in_indices)
 Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index, HPS.Cylinder.Component in_apply_to)
 Sets a single material index on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index)
 Sets a single material index on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors, HPS.Cylinder.Component in_apply_to)
 Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors)
 Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color, HPS.Cylinder.Component in_apply_to)
 Sets a single RGB color on a selection of arbitrary vertices which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color)
 Sets a single RGB color on a selection of arbitrary vertices which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors, HPS.Cylinder.Component in_apply_to)
 Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors)
 Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color, HPS.Cylinder.Component in_apply_to)
 Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
 
HPS.CylinderKit SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color)
 Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
 
void Show (out HPS.CylinderKit out_kit)
 Copies this CylinderKit into the given CylinderKit. More...
 
bool ShowCaps (out HPS.Cylinder.Capping out_caps)
 Show the capping for this CylinderKit. More...
 
bool ShowPoints (out HPS.Point[] out_points)
 Show the points for this CylinderKit. More...
 
bool ShowPriority (out int out_priority)
 Shows the drawing priority. More...
 
bool ShowRadii (out float[] out_radii)
 Show the radii for this CylinderKit. More...
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 Shows the user data at a given index for this kit. More...
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 Shows all user data for this kit. More...
 
ulong ShowUserDataCount ()
 Get the number of user data indices set on this kit. More...
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 Shows the indices of all user data set on this kit. More...
 
bool ShowVertexColorsByList (ulong[] in_vertices, HPS.Cylinder.Component in_applied_to, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)
 Shows the vertex colors on a selection of arbitrary vertices which apply to the specified cylinder component. More...
 
bool ShowVertexColorsByRange (ulong in_start, ulong in_count, HPS.Cylinder.Component in_applied_to, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)
 Shows the vertex colors on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
 
HPS.CylinderKit UnsetAllUserData ()
 Removes all user data from this kit. More...
 
HPS.CylinderKit UnsetCaps ()
 Removes the capping for this CylinderKit. More...
 
HPS.CylinderKit UnsetEverything ()
 Removes all settings from the CylinderKit. More...
 
HPS.CylinderKit UnsetPoints ()
 Removes the points for this CylinderKit. More...
 
HPS.CylinderKit UnsetPriority ()
 Removes a drawing priority setting. More...
 
HPS.CylinderKit UnsetRadii ()
 Removes the radii for this CylinderKit. More...
 
HPS.CylinderKit UnsetUserData (IntPtr in_index)
 Removes the user data at the given index from this kit. More...
 
HPS.CylinderKit UnsetUserData (IntPtr[] in_indices)
 Removes the user data at the given indices from this kit. More...
 
HPS.CylinderKit UnsetVertexColors ()
 Removes all vertex colors (RGB colors or material indices) for all cylinder components. More...
 
HPS.CylinderKit UnsetVertexColors (HPS.Cylinder.Component in_apply_to)
 Removes all vertex colors (RGB colors or material indices) for the specified cylinder component. More...
 
HPS.CylinderKit UnsetVertexColorsByList (ulong[] in_vertices)
 Removes the vertex colors (RGB colors or material indices) for all cylinder components on a selection of arbitrary vertices. More...
 
HPS.CylinderKit UnsetVertexColorsByList (ulong[] in_vertices, HPS.Cylinder.Component in_apply_to)
 Removes the vertex colors (RGB colors or material indices) for the specified cylinder component on a selection of arbitrary vertices. More...
 
HPS.CylinderKit UnsetVertexColorsByRange (ulong in_start, ulong in_count)
 Removes the specified range of vertex colors (RGB colors or material indices) for all cylinder components starting at the specified offset. More...
 
HPS.CylinderKit UnsetVertexColorsByRange (ulong in_start, ulong in_count, HPS.Cylinder.Component in_apply_to)
 Removes the specified range of vertex colors (RGB colors or material indices) for the specified cylinder component starting at the specified offset. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

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.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

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

Detailed Description

The CylinderKit class is a user space object.

It is a kit analog to a CylinderKey.

Constructor & Destructor Documentation

HPS.CylinderKit.CylinderKit ( )

The default constructor creates an empty CylinderKit object.

HPS.CylinderKit.CylinderKit ( HPS.CylinderKit  in_kit)

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> to copy.

Member Function Documentation

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

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> to consume.
override bool HPS.CylinderKit.Empty ( )
virtual

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.

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

Check if the source CylinderKit is equivalent to this CylinderKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> to compare to this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
ulong HPS.CylinderKit.GetPointCount ( )

Retrieves the number of points in this cylinder.

Returns
The number of points in this cylinder.
override HPS.Type HPS.CylinderKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

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

Copies the source CylinderKit into this CylinderKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> to copy.
HPS.CylinderKit HPS.CylinderKit.SetCaps ( HPS.Cylinder.Capping  in_capping)

Sets the capping for this CylinderKit.

Parameters
in_cappingThe capping for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.SetPoints ( HPS.Point[]  in_points)

Sets the points for this CylinderKit.

Parameters
in_countSize of the following array.
in_pointsThe points for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.SetPriority ( int  in_priority)

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.

SubwindowKit::SetPriority()

SubwindowKit::SetRenderingAlgorithm()

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

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_countSize of the following array.
in_radiiThe radii for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.SetUserData ( IntPtr  in_index,
ulong  in_bytes,
byte[]  in_data 
)

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.
HPS.CylinderKit HPS.CylinderKit.SetUserData ( IntPtr  in_index,
byte[]  in_data 
)

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.
HPS.CylinderKit HPS.CylinderKit.SetUserData ( IntPtr[]  in_indices,
byte  in_data[][] 
)

Sets user data on this kit.

Parameters
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.
HPS.CylinderKit HPS.CylinderKit.SetVertexIndexColorsByList ( ulong[]  in_vertices,
float[]  in_indices,
HPS.Cylinder.Component  in_apply_to 
)

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

Parameters
in_countSize of the following arrays.
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 <ref refid="class_h_p_s_1_1_cylinder_1ab47e3177b438e2b75d3abc8613dcf2e5a4f93ea0836ba76b6f9b81e3eee53a3af" kindref="member">Cylinder::Component::Faces</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.SetVertexIndexColorsByList ( ulong[]  in_vertices,
float[]  in_indices 
)

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

Parameters
in_countSize of the following arrays.
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.
HPS.CylinderKit HPS.CylinderKit.SetVertexIndexColorsByList ( ulong[]  in_vertices,
float  in_index,
HPS.Cylinder.Component  in_apply_to 
)

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

Parameters
in_countSize of the following array.
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 <ref refid="class_h_p_s_1_1_cylinder_1ab47e3177b438e2b75d3abc8613dcf2e5a4f93ea0836ba76b6f9b81e3eee53a3af" kindref="member">Cylinder::Component::Faces</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.SetVertexIndexColorsByList ( ulong[]  in_vertices,
float  in_index 
)

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

Parameters
in_countSize of the following array.
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.
HPS.CylinderKit HPS.CylinderKit.SetVertexIndexColorsByRange ( ulong  in_start,
float[]  in_indices,
HPS.Cylinder.Component  in_apply_to 
)

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 <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> at which to start setting colors.
in_countSize of the following array.
in_indicesThe material indices to set on the vertices for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
in_apply_toThe cylinder component the colors should apply to. Defaults to <ref refid="class_h_p_s_1_1_cylinder_1ab47e3177b438e2b75d3abc8613dcf2e5a4f93ea0836ba76b6f9b81e3eee53a3af" kindref="member">Cylinder::Component::Faces</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.SetVertexIndexColorsByRange ( ulong  in_start,
float[]  in_indices 
)

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

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> at which to start setting colors.
in_countSize of the following array.
in_indicesThe material indices to set on the vertices for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.SetVertexIndexColorsByRange ( ulong  in_start,
ulong  in_count,
float  in_index,
HPS.Cylinder.Component  in_apply_to 
)

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 <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> 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 <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
in_apply_toThe cylinder component the colors should apply to. Defaults to <ref refid="class_h_p_s_1_1_cylinder_1ab47e3177b438e2b75d3abc8613dcf2e5a4f93ea0836ba76b6f9b81e3eee53a3af" kindref="member">Cylinder::Component::Faces</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.SetVertexIndexColorsByRange ( ulong  in_start,
ulong  in_count,
float  in_index 
)

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

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> 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 <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.SetVertexRGBColorsByList ( ulong[]  in_vertices,
HPS.RGBColor[]  in_rgb_colors,
HPS.Cylinder.Component  in_apply_to 
)

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

Parameters
in_countSize of the following arrays.
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 <ref refid="class_h_p_s_1_1_cylinder_1ab47e3177b438e2b75d3abc8613dcf2e5a4f93ea0836ba76b6f9b81e3eee53a3af" kindref="member">Cylinder::Component::Faces</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.SetVertexRGBColorsByList ( ulong[]  in_vertices,
HPS.RGBColor[]  in_rgb_colors 
)

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

Parameters
in_countSize of the following arrays.
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.
HPS.CylinderKit HPS.CylinderKit.SetVertexRGBColorsByList ( ulong[]  in_vertices,
HPS.RGBColor  in_rgb_color,
HPS.Cylinder.Component  in_apply_to 
)

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

Parameters
in_countSize of the following array.
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 <ref refid="class_h_p_s_1_1_cylinder_1ab47e3177b438e2b75d3abc8613dcf2e5a4f93ea0836ba76b6f9b81e3eee53a3af" kindref="member">Cylinder::Component::Faces</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.SetVertexRGBColorsByList ( ulong[]  in_vertices,
HPS.RGBColor  in_rgb_color 
)

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

Parameters
in_countSize of the following array.
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.
HPS.CylinderKit HPS.CylinderKit.SetVertexRGBColorsByRange ( ulong  in_start,
HPS.RGBColor[]  in_rgb_colors,
HPS.Cylinder.Component  in_apply_to 
)

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 <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> at which to start setting colors.
in_countSize of the following array.
in_rgb_colorsThe RGB colors to set on the vertices for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
in_apply_toThe cylinder component the colors should apply to. Defaults to <ref refid="class_h_p_s_1_1_cylinder_1ab47e3177b438e2b75d3abc8613dcf2e5a4f93ea0836ba76b6f9b81e3eee53a3af" kindref="member">Cylinder::Component::Faces</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.SetVertexRGBColorsByRange ( ulong  in_start,
HPS.RGBColor[]  in_rgb_colors 
)

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

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> at which to start setting colors.
in_countSize of the following array.
in_rgb_colorsThe RGB colors to set on the vertices for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.SetVertexRGBColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.RGBColor  in_rgb_color,
HPS.Cylinder.Component  in_apply_to 
)

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 <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> 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 <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
in_apply_toThe cylinder component the colors should apply to. Defaults to <ref refid="class_h_p_s_1_1_cylinder_1ab47e3177b438e2b75d3abc8613dcf2e5a4f93ea0836ba76b6f9b81e3eee53a3af" kindref="member">Cylinder::Component::Faces</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.SetVertexRGBColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.RGBColor  in_rgb_color 
)

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

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> 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 <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
Returns
A reference to this CylinderKit.
void HPS.CylinderKit.Show ( out HPS.CylinderKit  out_kit)

Copies this CylinderKit into the given CylinderKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
bool HPS.CylinderKit.ShowCaps ( out HPS.Cylinder.Capping  out_caps)

Show the capping for this CylinderKit.

Parameters
out_capsThe capping for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
Returns
true if a capping was set, false otherwise.
bool HPS.CylinderKit.ShowPoints ( out HPS.Point[]  out_points)

Show the points for this CylinderKit.

Parameters
out_pointsThe points for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
Returns
true if points were set, false otherwise.
bool HPS.CylinderKit.ShowPriority ( out int  out_priority)

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.
bool HPS.CylinderKit.ShowRadii ( out float[]  out_radii)

Show the radii for this CylinderKit.

Parameters
out_radiiThe radii for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
Returns
true if radii were set, false otherwise.
bool HPS.CylinderKit.ShowUserData ( IntPtr  in_index,
out byte[]  out_data 
)

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.
bool HPS.CylinderKit.ShowUserData ( out IntPtr[]  out_indices,
out byte  out_data[][] 
)

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
Returns
true if there is user data on this kit, false otherwise.
ulong HPS.CylinderKit.ShowUserDataCount ( )

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

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

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.
bool HPS.CylinderKit.ShowVertexColorsByList ( ulong[]  in_vertices,
HPS.Cylinder.Component  in_applied_to,
out HPS.Material.Type[]  out_types,
out HPS.RGBColor[]  out_rgb_colors,
out float[]  out_indices 
)

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.
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 <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18daf80a4ad87fee7c9fdc19b7769495fdb5" kindref="member">Material::Type::Nothing</ref>.
out_rgb_colorsThe RGB colors for each vertex at the specified index. out_rgb_colors[i] is only valid if out_types[i] is <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18da675716a4db2321401bb4c4924e6ea710" kindref="member">Material::Type::ExplicitRGBColor</ref>.
out_indicesThe material indices for each vertex at the specified index. The out_indices[i] is only valid if out_types[i] is <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18da3e21f60632b7774f92151ddc6b0c64b5" kindref="member">Material::Type::MaterialIndex</ref>.
Returns
true if any specified vertex had a vertex color on the specified component set, false otherwise.
bool HPS.CylinderKit.ShowVertexColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.Cylinder.Component  in_applied_to,
out HPS.Material.Type[]  out_types,
out HPS.RGBColor[]  out_rgb_colors,
out float[]  out_indices 
)

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 <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> at which to start showing colors.
in_countThe number of colors to show.
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 <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18daf80a4ad87fee7c9fdc19b7769495fdb5" kindref="member">Material::Type::Nothing</ref>.
out_rgb_colorsThe RGB colors for each vertex in the specified range. out_rgb_colors[i] is only valid if out_types[i] is <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18da675716a4db2321401bb4c4924e6ea710" kindref="member">Material::Type::ExplicitRGBColor</ref>.
out_indicesThe material indices for each vertex in the specified range. The out_indices[i] is only valid if out_types[i] is <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18da3e21f60632b7774f92151ddc6b0c64b5" kindref="member">Material::Type::MaterialIndex</ref>.
Returns
true if any vertex in the specified range had a vertex color on the specified component set, false otherwise.
HPS.CylinderKit HPS.CylinderKit.UnsetAllUserData ( )

Removes all user data from this kit.

Returns
A reference to this kit.
HPS.CylinderKit HPS.CylinderKit.UnsetCaps ( )

Removes the capping for this CylinderKit.

Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.UnsetEverything ( )

Removes all settings from the CylinderKit.

Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.UnsetPoints ( )

Removes the points for this CylinderKit.

Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.UnsetPriority ( )

Removes a drawing priority setting.

Returns
A reference to this object.
HPS.CylinderKit HPS.CylinderKit.UnsetRadii ( )

Removes the radii for this CylinderKit.

Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.UnsetUserData ( IntPtr  in_index)

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.
HPS.CylinderKit HPS.CylinderKit.UnsetUserData ( IntPtr[]  in_indices)

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

Parameters
in_countThe size of the following array.
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.
HPS.CylinderKit HPS.CylinderKit.UnsetVertexColors ( )

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

Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.UnsetVertexColors ( HPS.Cylinder.Component  in_apply_to)

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.
HPS.CylinderKit HPS.CylinderKit.UnsetVertexColorsByList ( ulong[]  in_vertices)

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.
HPS.CylinderKit HPS.CylinderKit.UnsetVertexColorsByList ( ulong[]  in_vertices,
HPS.Cylinder.Component  in_apply_to 
)

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.
HPS.CylinderKit HPS.CylinderKit.UnsetVertexColorsByRange ( ulong  in_start,
ulong  in_count 
)

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 <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> at which to start removing colors.
in_countThe number of vertex colors to remove for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
Returns
A reference to this CylinderKit.
HPS.CylinderKit HPS.CylinderKit.UnsetVertexColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.Cylinder.Component  in_apply_to 
)

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 <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref> at which to start removing colors.
in_countThe number of vertex colors to remove for this <ref refid="class_h_p_s_1_1_cylinder_kit" kindref="compound">CylinderKit</ref>.
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: