The CylinderKit class is a user space object. It is a kit analog to a CylinderKey. More...
Public Member Functions | |
override void | Dispose () |
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 HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Consume (HPS.CylinderKit in_kit) |
Copies the source CylinderKit into this CylinderKit and resets the source kit. More... | |
void | Set (HPS.CylinderKit in_kit) |
Copies the source CylinderKit into this CylinderKit. More... | |
void | Show (out HPS.CylinderKit out_kit) |
Copies this CylinderKit into the given CylinderKit. More... | |
override bool | Empty () |
Indicates whether this CylinderKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.CylinderKit in_kit) |
Check if the source CylinderKit is equivalent to this CylinderKit. More... | |
ulong | GetPointCount () |
Retrieves the number of points in this cylinder. More... | |
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. More... | |
HPS.CylinderKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
HPS.CylinderKit | SetPoints (HPS.Point[] in_points) |
Sets the points for this CylinderKit. More... | |
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. More... | |
HPS.CylinderKit | SetCaps (HPS.Cylinder.Capping in_capping) |
Sets the capping for this CylinderKit. More... | |
HPS.CylinderKit | UnsetPoints () |
Removes the points for this CylinderKit. More... | |
HPS.CylinderKit | UnsetRadii () |
Removes the radii for this CylinderKit. More... | |
HPS.CylinderKit | UnsetCaps () |
Removes the capping for this CylinderKit. More... | |
HPS.CylinderKit | UnsetEverything () |
Removes all settings from the CylinderKit. More... | |
bool | ShowPoints (out HPS.Point[] out_points) |
Show the points for this CylinderKit. More... | |
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. More... | |
bool | ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points) |
Show a subset of the points for this CylinderKit by list. More... | |
bool | ShowRadii (out float[] out_radii) |
Show the radii for this CylinderKit. More... | |
bool | ShowCaps (out HPS.Cylinder.Capping out_caps) |
Show the capping for this CylinderKit. 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... | |
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. 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. If the sizes of the vertex index array and the color array different, the smaller size will be used. 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 | 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 | 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. 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. If the sizes of the vertex index and material index arrays are different, the smaller size will be used. 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 | 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 | 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... | |
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... | |
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. More... | |
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]. 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 | 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 | UnsetAllUserData () |
Removes all user data from 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 | 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... | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object that) | |
HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Static Public Member Functions | |
static bool | operator== (HPS.CylinderKit a, HPS.CylinderKit b) |
static bool | operator!= (HPS.CylinderKit a, HPS.CylinderKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The CylinderKit class is a user space object. It is a kit analog to a CylinderKey.
|
inline |
The default constructor creates an empty CylinderKit object.
|
inline |
The copy constructor creates a new CylinderKit object that contains the same settings as the source CylinderKit.
in_kit | The source CylinderKit to copy. |
|
inline |
Copies the source CylinderKit into this CylinderKit and resets the source kit.
in_kit | The source CylinderKit to consume. |
|
inlinevirtual |
Indicates whether this CylinderKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source CylinderKit is equivalent to this CylinderKit.
in_kit | The source CylinderKit to compare to this CylinderKit. |
|
inline |
Retrieves the number of points in this cylinder.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
Copies the source CylinderKit into this CylinderKit.
in_kit | The source CylinderKit to copy. |
|
inline |
Sets the capping for this CylinderKit.
in_capping | The capping for this CylinderKit. |
|
inline |
Sets the points for this CylinderKit.
in_points | The points for this CylinderKit. |
|
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.
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
SubwindowKit::SetPriority()
|
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.
in_radii | The radii for this CylinderKit. |
|
inline |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_bytes | The number of bytes of user data to set. |
in_data | The bytes of user data to set. |
|
inline |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
|
inline |
Sets user data on this kit.
in_indices | An array of user data indices to set. |
in_data | An array of bytes of user data to set. |
|
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.
in_vertices | The indices of the vertices on which to set the colors. |
in_indices | The material indices to set on the vertices. |
in_apply_to | The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces. |
|
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.
in_vertices | The indices of the vertices on which to set the colors. |
in_indices | The material indices to set on the vertices. |
|
inline |
Sets a single material index on a selection of arbitrary vertices which apply to the specified cylinder component.
in_vertices | The indices of the vertices on which to set the color. |
in_index | The material index to set on the vertices. |
in_apply_to | The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces. |
|
inline |
Sets a single material index on a selection of arbitrary vertices which apply to the specified cylinder component.
in_vertices | The indices of the vertices on which to set the color. |
in_index | The material index to set on the vertices. |
|
inline |
Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified cylinder component.
in_start | The offset into the vertices for this CylinderKit at which to start setting colors. |
in_indices | The material indices to set on the vertices for this CylinderKit. |
in_apply_to | The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces. |
|
inline |
Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified cylinder component.
in_start | The offset into the vertices for this CylinderKit at which to start setting colors. |
in_indices | The material indices to set on the vertices for this CylinderKit. |
|
inline |
Sets a single material index on a range of vertices starting at the specified offset which apply to the specified cylinder component.
in_start | The offset into the vertices for this CylinderKit at which to start setting the color. |
in_count | The number of vertices on which to set the color. |
in_index | The material index to set on the vertices for this CylinderKit. |
in_apply_to | The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces. |
|
inline |
Sets a single material index on a range of vertices starting at the specified offset which apply to the specified cylinder component.
in_start | The offset into the vertices for this CylinderKit at which to start setting the color. |
in_count | The number of vertices on which to set the color. |
in_index | The material index to set on the vertices for this CylinderKit. |
|
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.
in_vertices | The indices of the vertices on which to set the colors. |
in_rgb_colors | The RGB colors to set on the vertices. |
in_apply_to | The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces. |
|
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.
in_vertices | The indices of the vertices on which to set the colors. |
in_rgb_colors | The RGB colors to set on the vertices. |
|
inline |
Sets a single RGB color on a selection of arbitrary vertices which apply to the specified cylinder component.
in_vertices | The indices of the vertices on which to set the color. |
in_rgb_color | The RGB color to set on the vertices. |
in_apply_to | The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces. |
|
inline |
Sets a single RGB color on a selection of arbitrary vertices which apply to the specified cylinder component.
in_vertices | The indices of the vertices on which to set the color. |
in_rgb_color | The RGB color to set on the vertices. |
|
inline |
Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified cylinder component.
in_start | The offset into the vertices for this CylinderKit at which to start setting colors. |
in_rgb_colors | The RGB colors to set on the vertices for this CylinderKit. |
in_apply_to | The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces. |
|
inline |
Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified cylinder component.
in_start | The offset into the vertices for this CylinderKit at which to start setting colors. |
in_rgb_colors | The RGB colors to set on the vertices for this CylinderKit. |
|
inline |
Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified cylinder component.
in_start | The offset into the vertices for this CylinderKit at which to start setting the color. |
in_count | The number of vertices on which to set the color. |
in_rgb_color | The RGB color to set on the vertices for this CylinderKit. |
in_apply_to | The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces. |
|
inline |
Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified cylinder component.
in_start | The offset into the vertices for this CylinderKit at which to start setting the color. |
in_count | The number of vertices on which to set the color. |
in_rgb_color | The RGB color to set on the vertices for this CylinderKit. |
|
inline |
Copies this CylinderKit into the given CylinderKit.
out_kit | The CylinderKit to populate with the contents of this CylinderKit. |
|
inline |
Show the capping for this CylinderKit.
out_caps | The capping for this CylinderKit. |
|
inline |
Show the points for this CylinderKit.
out_points | The points for this CylinderKit. |
|
inline |
Show a subset of the points for this CylinderKit by list.
in_indices | The list of point indices to show. |
out_points | The requested points for this CylinderKit. |
|
inline |
Show a subset of the points for this CylinderKit by range.
in_start_index | The first point to show. |
in_count | The number of points to show. |
out_points | The requested points for this CylinderKit. |
|
inline |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
|
inline |
Show the radii for this CylinderKit.
out_radii | The radii for this CylinderKit. |
|
inline |
Shows the user data at a given index for this kit.
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
|
inline |
Shows all user data for this kit.
out_indices | An array of all user data indices set on this kit. |
out_data | An array of all user data set on this kit. |
|
inline |
Get the number of user data indices set on this kit.
|
inline |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
|
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].
in_vertices | The indices of the vertices on which to show the colors. |
in_apply_to | The cylinder component the colors should apply to. |
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::Nothing. |
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::ExplicitRGBColor. |
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. |
|
inline |
Shows the vertex colors on a range of vertices starting at the specified offset which apply to the specified cylinder component.
in_start | The offset into the vertices for this CylinderKit at which to start showing colors. |
in_count | The number of colors to show. |
in_apply_to | The cylinder component the colors should apply to. |
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::Nothing. |
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::ExplicitRGBColor. |
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. |
|
inline |
Removes all user data from this kit.
|
inline |
Removes the capping for this CylinderKit.
|
inline |
Removes all settings from the CylinderKit.
|
inline |
Removes the points for this CylinderKit.
|
inline |
Removes a drawing priority setting.
|
inline |
Removes the radii for this CylinderKit.
|
inline |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
|
inline |
Removes the user data at the given indices from this kit.
in_indices | The indices of the user data to remove. |
|
inline |
Removes all vertex colors (RGB colors or material indices) for all cylinder components.
|
inline |
Removes all vertex colors (RGB colors or material indices) for the specified cylinder component.
in_apply_to | The cylinder component for which to remove the colors. |
|
inline |
Removes the vertex colors (RGB colors or material indices) for all cylinder components on a selection of arbitrary vertices.
in_vertices | The indices of the vertices on which to remove the colors. |
|
inline |
Removes the vertex colors (RGB colors or material indices) for the specified cylinder component on a selection of arbitrary vertices.
in_vertices | The indices of the vertices on which to remove the colors. |
in_apply_to | The cylinder component for which to remove the colors. |
|
inline |
Removes the specified range of vertex colors (RGB colors or material indices) for all cylinder components starting at the specified offset.
in_start | The offset into the vertices for this CylinderKit at which to start removing colors. |
in_count | The number of vertex colors to remove for this CylinderKit. |
|
inline |
Removes the specified range of vertex colors (RGB colors or material indices) for the specified cylinder component starting at the specified offset.
in_start | The offset into the vertices for this CylinderKit at which to start removing colors. |
in_count | The number of vertex colors to remove for this CylinderKit. |
in_apply_to | The cylinder component for which to remove the colors. |