CylinderKit

class HPS.CylinderKit : public HPS.Kit 

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

Public Functions

void Consume (HPS.CylinderKit in_kit)

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

Param in_kit: The source CylinderKit to consume.

CylinderKit (): The default constructor creates an empty CylinderKit object.

CylinderKit (HPS.CylinderKit in_kit)

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

Param in_kit: The source CylinderKit to copy.

override void Dispose ()

override bool Empty ()

Indicates whether this CylinderKit has any values set on it.

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

bool Equals (HPS.CylinderKit in_kit)

Check if the source CylinderKit is equivalent to this CylinderKit.

Param in_kit: The source CylinderKit to compare to this CylinderKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

ulong GetPointCount ()

Retrieves the number of points in this cylinder.

Return: The number of points in this cylinder.

override HPS.Type ObjectType ()

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).

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

void Set (HPS.CylinderKit in_kit)

Copies the source CylinderKit into this CylinderKit.

Param in_kit: The source CylinderKit to copy.

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

Sets the capping for this CylinderKit.

Param in_capping: The capping for this CylinderKit.
Return: A reference to this CylinderKit.

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

Sets the points for this CylinderKit.

Param in_points: The points for this CylinderKit.
Return: A reference to this 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.

See: SubwindowKit.SetPriority()
See: SubwindowKit.SetRenderingAlgorithm()

Param in_priority: The drawing priority, higher priority items are drawn on top of lower priority items.
Return: A reference to this object.

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.

Param in_radii: The radii for this CylinderKit.
Return: A reference to this CylinderKit.

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

Sets user data on this kit.

Param in_index: The index of the user data to set.
Param in_data: The bytes of user data to set.
Return: A reference to this kit.

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

Sets user data on this kit.

Param in_index: The index of the user data to set.
Param in_bytes: The number of bytes of user data to set.
Param in_data: The bytes of user data to set.
Return: A reference to this kit.

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

Sets user data on this kit.

Param in_indices: An array of user data indices to set.
Param in_data: An array of bytes of user data to set.
Return: A reference to this kit.

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.

Param in_vertices: The indices of the vertices on which to set the color.
Param in_index: The material index to set on the vertices.
Return: A reference to this 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.

Param in_vertices: The indices of the vertices on which to set the color.
Param in_index: The material index to set on the vertices.
Param in_apply_to: The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Return: A reference to this 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. If the sizes of the vertex index and material index arrays are different, the smaller size will be used.

Param in_vertices: The indices of the vertices on which to set the colors.
Param in_indices: The material indices to set on the vertices.
Return: A reference to this 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. If the sizes of the vertex index and material index arrays are different, the smaller size will be used.

Param in_vertices: The indices of the vertices on which to set the colors.
Param in_indices: The material indices to set on the vertices.
Param in_apply_to: The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Return: A reference to this 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.

Param in_start: The offset into the vertices for this CylinderKit at which to start setting colors.
Param in_indices: The material indices to set on the vertices for this CylinderKit.
Return: A reference to this 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.

Param in_start: The offset into the vertices for this CylinderKit at which to start setting colors.
Param in_indices: The material indices to set on the vertices for this CylinderKit.
Param in_apply_to: The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Return: A reference to this 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.

Param in_start: The offset into the vertices for this CylinderKit at which to start setting the color.
Param in_count: The number of vertices on which to set the color.
Param in_index: The material index to set on the vertices for this CylinderKit.
Return: A reference to this 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.

Param in_start: The offset into the vertices for this CylinderKit at which to start setting the color.
Param in_count: The number of vertices on which to set the color.
Param in_index: The material index to set on the vertices for this CylinderKit.
Param in_apply_to: The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Return: A reference to this 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.

Param in_vertices: The indices of the vertices on which to set the color.
Param in_rgb_color: The RGB color to set on the vertices.
Return: A reference to this 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.

Param in_vertices: The indices of the vertices on which to set the color.
Param in_rgb_color: The RGB color to set on the vertices.
Param in_apply_to: The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Return: A reference to this 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. If the sizes of the vertex index array and the color array different, the smaller size will be used.

Param in_vertices: The indices of the vertices on which to set the colors.
Param in_rgb_colors: The RGB colors to set on the vertices.
Return: A reference to this 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. If the sizes of the vertex index array and the color array different, the smaller size will be used.

Param in_vertices: The indices of the vertices on which to set the colors.
Param in_rgb_colors: The RGB colors to set on the vertices.
Param in_apply_to: The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Return: A reference to this 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.

Param in_start: The offset into the vertices for this CylinderKit at which to start setting colors.
Param in_rgb_colors: The RGB colors to set on the vertices for this CylinderKit.
Return: A reference to this 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.

Param in_start: The offset into the vertices for this CylinderKit at which to start setting colors.
Param in_rgb_colors: The RGB colors to set on the vertices for this CylinderKit.
Param in_apply_to: The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Return: A reference to this 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.

Param in_start: The offset into the vertices for this CylinderKit at which to start setting the color.
Param in_count: The number of vertices on which to set the color.
Param in_rgb_color: The RGB color to set on the vertices for this CylinderKit.
Return: A reference to this 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.

Param in_start: The offset into the vertices for this CylinderKit at which to start setting the color.
Param in_count: The number of vertices on which to set the color.
Param in_rgb_color: The RGB color to set on the vertices for this CylinderKit.
Param in_apply_to: The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
Return: A reference to this CylinderKit.

void Show (out HPS.CylinderKit out_kit)

Copies this CylinderKit into the given CylinderKit.

Param out_kit: The CylinderKit to populate with the contents of this CylinderKit.

bool ShowCaps (out HPS.Cylinder.Capping out_caps)

Show the capping for this CylinderKit.

Param out_caps: The capping for this CylinderKit.
Return: true if a capping was set, false otherwise.

bool ShowPoints (out HPS.Point[] out_points)

Show the points for this CylinderKit.

Param out_points: The points for this CylinderKit.
Return: true if points were set, false otherwise.

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

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

Param in_indices: The list of point indices to show.
Param out_points: The requested points for this CylinderKit.
Return: true if all requested points were set, false otherwise.

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

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

Param in_start_index: The first point to show.
Param in_count: The number of points to show.
Param out_points: The requested points for this CylinderKit.
Return: true if all requested points were set, false otherwise.

bool ShowPriority (out int out_priority)

Shows the drawing priority.

Param out_priority: The drawing priority, higher priority items are drawn on top of lower priority items.
Return: true if the setting is valid, false otherwise.

bool ShowRadii (out float[] out_radii)

Show the radii for this CylinderKit.

Param out_radii: The radii for this CylinderKit.
Return: true if radii were set, false otherwise.

bool ShowUserData (IntPtr in_index, out byte[] out_data)

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

Param in_index: The index of the user data to show.
Param out_data: The user data at the given index.
Return: true if there is user data at the given index, false otherwise.

bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)

Shows all user data for this kit.

Param out_indices: An array of all user data indices set on this kit.
Param out_data: An array of all user data set on this kit.
Return: true if there is user data on this kit, false otherwise.

ulong ShowUserDataCount (): Get the number of user data indices set on this kit.

bool ShowUserDataIndices (out IntPtr[] out_indices)

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

Param out_indices: The user data indices set on this kit.
Return: The number of user data indices set on this kit.

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

Shows all the vertex colors of the specified cylinder component.

Param in_apply_to: The cylinder component the colors should apply to.
Param out_types: The 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.
Param out_rgb_colors: The RGB colors for each vertex. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor.
Param out_indices: The material indices for each vertex. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
Return: true if any vertex colors were shown, false otherwise.

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)

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].

Param in_vertices: The indices of the vertices on which to show the colors.
Param in_apply_to: The cylinder component the colors should apply to.
Param out_types: The types of vertex colors for each vertex at the specified index. If a vertex at a specified index does not have a vertex color set for the specified component, the entry in this array will be Material.Type.None.
Param out_rgb_colors: The RGB colors for each vertex at the specified index. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor.
Param out_indices: The material indices for each vertex at the specified index. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
Return: true if any specified vertex had a vertex color on the specified component set, false otherwise.

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)

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

Param in_start: The offset into the vertices for this CylinderKit at which to start showing colors.
Param in_count: The number of colors to show.
Param in_apply_to: The cylinder component the colors should apply to.
Param out_types: The types of vertex colors for each vertex in the specified range. If a vertex in the specified range does not have a vertex color set for the specified cylinder component, the entry in this array will be Material.Type.None.
Param out_rgb_colors: The RGB colors for each vertex in the specified range. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor.
Param out_indices: The material indices for each vertex in the specified range. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
Return: true if any vertex in the specified range had a vertex color on the specified component set, false otherwise.

HPS.CylinderKit UnsetAllUserData ()

Removes all user data from this kit.

Return: A reference to this kit.

HPS.CylinderKit UnsetCaps ()

Removes the capping for this CylinderKit.

Return: A reference to this CylinderKit.

HPS.CylinderKit UnsetEverything ()

Removes all settings from the CylinderKit.

Return: A reference to this CylinderKit.

HPS.CylinderKit UnsetPoints ()

Removes the points for this CylinderKit.

Return: A reference to this CylinderKit.

HPS.CylinderKit UnsetPriority ()

Removes a drawing priority setting.

Return: A reference to this object.

HPS.CylinderKit UnsetRadii ()

Removes the radii for this CylinderKit.

Return: A reference to this CylinderKit.

HPS.CylinderKit UnsetUserData (IntPtr in_index)

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

Param in_index: The index of the user data to remove.
Return: A reference to this kit.

HPS.CylinderKit UnsetUserData (IntPtr[] in_indices)

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

Param in_indices: The indices of the user data to remove.
Return: A reference to this kit.

HPS.CylinderKit UnsetVertexColors ()

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

Return: A reference to this CylinderKit.

HPS.CylinderKit UnsetVertexColors (HPS.Cylinder.Component in_apply_to)

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

Param in_apply_to: The cylinder component for which to remove the colors.
Return: A reference to this 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.

Param in_vertices: The indices of the vertices on which to remove the colors.
Return: A reference to this 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.

Param in_vertices: The indices of the vertices on which to remove the colors.
Param in_apply_to: The cylinder component for which to remove the colors.
Return: A reference to this 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.

Param in_start: The offset into the vertices for this CylinderKit at which to start removing colors.
Param in_count: The number of vertex colors to remove for this CylinderKit.
Return: A reference to this 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.

Param in_start: The offset into the vertices for this CylinderKit at which to start removing colors.
Param in_count: The number of vertex colors to remove for this CylinderKit.
Param in_apply_to: The cylinder component for which to remove the colors.
Return: A reference to this CylinderKit.

Public Static Functions

bool operator!= (HPS.CylinderKit a, HPS.CylinderKit b)

bool operator== (HPS.CylinderKit a, HPS.CylinderKit b)