REFERENCE MANUAL
The CuttingSectionKit class is a user space object. More...
Public Member Functions | |
void | Consume (HPS.CuttingSectionKit in_kit) |
Copies the source CuttingSectionKit into this CuttingSectionKit and resets the source kit. More... | |
CuttingSectionKit () | |
The default constructor creates an empty CuttingSectionKit object. More... | |
CuttingSectionKit (HPS.CuttingSectionKit in_kit) | |
The copy constructor creates a new CuttingSectionKit object that contains the same settings as the source CuttingSectionKit. More... | |
override void | Dispose () |
HPS.CuttingSectionKit | EditPlanesByDeletion (ulong in_offset, ulong in_count) |
Removes planes from the cutting plane list for this CuttingSectionKit. More... | |
HPS.CuttingSectionKit | EditPlanesByInsertion (ulong in_offset, HPS.Plane[] in_planes) |
Adds cutting planes to this CuttingSectionKit. More... | |
HPS.CuttingSectionKit | EditPlanesByReplacement (ulong in_offset, HPS.Plane[] in_planes) |
Replaces planes in the cutting plane list for this CuttingSectionKit. More... | |
override bool | Empty () |
Indicates whether this CuttingSectionKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.CuttingSectionKit in_kit) |
Check if the source CuttingSectionKit is equivalent to this CuttingSectionKit. More... | |
override int | GetHashCode () |
ulong | GetPlaneCount () |
Gets the number of cutting planes for this CuttingSectionKit. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.CuttingSectionKit in_kit) |
Copies the source CuttingSectionKit into this CuttingSectionKit. More... | |
HPS.CuttingSectionKit | SetPlanes (HPS.Plane in_plane) |
Sets a single cutting plane for this CuttingSectionKit. More... | |
HPS.CuttingSectionKit | SetPlanes (HPS.Plane[] in_planes) |
Sets multiple cutting planes for this CuttingSectionKit. More... | |
HPS.CuttingSectionKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the CuttingSectionKit. More... | |
HPS.CuttingSectionKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.CuttingSectionKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.CuttingSectionKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
HPS.CuttingSectionKit | SetVisualization (HPS.CuttingSection.Mode in_mode, HPS.RGBAColor in_color, float in_scale) |
Sets visualization to use for this CuttingSectionKit. More... | |
HPS.CuttingSectionKit | SetVisualization (HPS.CuttingSection.Mode in_mode, HPS.RGBAColor in_color) |
Sets visualization to use for this CuttingSectionKit. More... | |
void | Show (out HPS.CuttingSectionKit out_kit) |
Copies this CuttingSectionKit into the given CuttingSectionKit. More... | |
bool | ShowPlanes (out HPS.Plane[] out_planes) |
Shows the cutting planes for this CuttingSectionKit. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. 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 | ShowVisualization (out HPS.CuttingSection.Mode out_mode, out HPS.RGBAColor out_color, out float out_scale) |
Shows the visualization to use for this CuttingSectionKit. More... | |
HPS.CuttingSectionKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
HPS.CuttingSectionKit | UnsetEverything () |
Removes all settings from the CuttingSectionKit. More... | |
HPS.CuttingSectionKit | UnsetPlanes () |
Removes the cutting planes for this CuttingSectionKit. More... | |
HPS.CuttingSectionKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
HPS.CuttingSectionKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.CuttingSectionKit | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this kit. More... | |
HPS.CuttingSectionKit | UnsetVisualization () |
Removes the visualization settings for this CuttingSectionKit. More... | |
![]() | |
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.CuttingSectionKit a, HPS.CuttingSectionKit b) |
static bool | operator== (HPS.CuttingSectionKit a, HPS.CuttingSectionKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The CuttingSectionKit class is a user space object.
It is a kit analog to a CuttingSectionKey.
HPS.CuttingSectionKit.CuttingSectionKit | ( | ) |
The default constructor creates an empty CuttingSectionKit object.
HPS.CuttingSectionKit.CuttingSectionKit | ( | HPS.CuttingSectionKit | in_kit | ) |
The copy constructor creates a new CuttingSectionKit object that contains the same settings as the source CuttingSectionKit.
in_kit | The source <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref> to copy. |
void HPS.CuttingSectionKit.Consume | ( | HPS.CuttingSectionKit | in_kit | ) |
Copies the source CuttingSectionKit into this CuttingSectionKit and resets the source kit.
in_kit | The source <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref> to consume. |
HPS.CuttingSectionKit HPS.CuttingSectionKit.EditPlanesByDeletion | ( | ulong | in_offset, |
ulong | in_count | ||
) |
Removes planes from the cutting plane list for this CuttingSectionKit.
in_offset | The offset into the cutting planes for this <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref> at which to start removing planes. This value must be such that in_offset<cutting_plane_count for deletion to succeed. |
in_count | The number of planes to remove from the cutting plane list for this <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref>. This value must be such that in_offset+in_count<=cutting_plane_count for the deletion to succeed. |
HPS.CuttingSectionKit HPS.CuttingSectionKit.EditPlanesByInsertion | ( | ulong | in_offset, |
HPS.Plane[] | in_planes | ||
) |
Adds cutting planes to this CuttingSectionKit.
in_offset | The offset into the cutting plane list for the <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref> at which to insert planes. This value must be such that in_offset<cutting_plane_count for insertion to succeed. |
in_count | Size of the following array. |
in_planes | The planes to insert into the cutting plane list at the specified offset. |
HPS.CuttingSectionKit HPS.CuttingSectionKit.EditPlanesByReplacement | ( | ulong | in_offset, |
HPS.Plane[] | in_planes | ||
) |
Replaces planes in the cutting plane list for this CuttingSectionKit.
in_offset | The offset into the cutting plane list for this <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref> at which to start replacing planes. This value must be such that in_offset<cutting_plane_count for replacement to succeed. |
in_count | Size of the following array. This value must be such that in_offset+in_count<=cutting_plane_count for the replacement to succeed. |
in_planes | The planes to use to replace those in the cutting plane list at the specified offset. |
|
virtual |
Indicates whether this CuttingSectionKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.CuttingSectionKit.Equals | ( | HPS.CuttingSectionKit | in_kit | ) |
Check if the source CuttingSectionKit is equivalent to this CuttingSectionKit.
in_kit | The source <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref> to compare to this <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref>. |
ulong HPS.CuttingSectionKit.GetPlaneCount | ( | ) |
Gets the number of cutting planes for this CuttingSectionKit.
|
virtual |
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.
void HPS.CuttingSectionKit.Set | ( | HPS.CuttingSectionKit | in_kit | ) |
Copies the source CuttingSectionKit into this CuttingSectionKit.
in_kit | The source <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref> to copy. |
HPS.CuttingSectionKit HPS.CuttingSectionKit.SetPlanes | ( | HPS.Plane | in_plane | ) |
Sets a single cutting plane for this CuttingSectionKit.
in_plane | The cutting plane for this <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref>. |
HPS.CuttingSectionKit HPS.CuttingSectionKit.SetPlanes | ( | HPS.Plane[] | in_planes | ) |
Sets multiple cutting planes for this CuttingSectionKit.
in_count | Size of the following array. |
in_planes | The cutting planes for this <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref>. |
HPS.CuttingSectionKit HPS.CuttingSectionKit.SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the CuttingSectionKit.
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()
HPS.CuttingSectionKit HPS.CuttingSectionKit.SetUserData | ( | IntPtr | in_index, |
ulong | in_bytes, | ||
byte[] | in_data | ||
) |
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. |
HPS.CuttingSectionKit HPS.CuttingSectionKit.SetUserData | ( | IntPtr | in_index, |
byte[] | in_data | ||
) |
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. |
HPS.CuttingSectionKit HPS.CuttingSectionKit.SetUserData | ( | IntPtr[] | in_indices, |
byte | in_data[][] | ||
) |
Sets user data on this kit.
in_data | An array of bytes of user data to set. |
HPS.CuttingSectionKit HPS.CuttingSectionKit.SetVisualization | ( | HPS.CuttingSection.Mode | in_mode, |
HPS.RGBAColor | in_color, | ||
float | in_scale | ||
) |
Sets visualization to use for this CuttingSectionKit.
in_mode | The mode for the <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref>. |
in_color | The RGBA color for the <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref>. |
in_scale | The scale to apply to the visualization geometry for this <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref>. Defaults to 1.0f. |
HPS.CuttingSectionKit HPS.CuttingSectionKit.SetVisualization | ( | HPS.CuttingSection.Mode | in_mode, |
HPS.RGBAColor | in_color | ||
) |
Sets visualization to use for this CuttingSectionKit.
in_mode | The mode for the <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref>. |
in_color | The RGBA color for the <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref>. |
void HPS.CuttingSectionKit.Show | ( | out HPS.CuttingSectionKit | out_kit | ) |
Copies this CuttingSectionKit into the given CuttingSectionKit.
out_kit | The <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref>. |
bool HPS.CuttingSectionKit.ShowPlanes | ( | out HPS.Plane[] | out_planes | ) |
Shows the cutting planes for this CuttingSectionKit.
out_planes | The cutting planes for this <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref>. |
bool HPS.CuttingSectionKit.ShowPriority | ( | out int | out_priority | ) |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
bool HPS.CuttingSectionKit.ShowUserData | ( | IntPtr | in_index, |
out byte[] | out_data | ||
) |
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. |
bool HPS.CuttingSectionKit.ShowUserData | ( | out IntPtr[] | out_indices, |
out byte | out_data[][] | ||
) |
Shows all user data for this kit.
out_indices | An array of all user data indices set on this kit. |
ulong HPS.CuttingSectionKit.ShowUserDataCount | ( | ) |
Get the number of user data indices set on this kit.
bool HPS.CuttingSectionKit.ShowUserDataIndices | ( | out IntPtr[] | out_indices | ) |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
bool HPS.CuttingSectionKit.ShowVisualization | ( | out HPS.CuttingSection.Mode | out_mode, |
out HPS.RGBAColor | out_color, | ||
out float | out_scale | ||
) |
Shows the visualization to use for this CuttingSectionKit.
out_mode | The mode for this <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref>. |
out_color | The RGBA color for this <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref>. |
out_scale | The scale to apply to the visualization geometry for this <ref refid="class_h_p_s_1_1_cutting_section_kit" kindref="compound">CuttingSectionKit</ref>. |
HPS.CuttingSectionKit HPS.CuttingSectionKit.UnsetAllUserData | ( | ) |
Removes all user data from this kit.
HPS.CuttingSectionKit HPS.CuttingSectionKit.UnsetEverything | ( | ) |
Removes all settings from the CuttingSectionKit.
HPS.CuttingSectionKit HPS.CuttingSectionKit.UnsetPlanes | ( | ) |
Removes the cutting planes for this CuttingSectionKit.
HPS.CuttingSectionKit HPS.CuttingSectionKit.UnsetPriority | ( | ) |
Removes a drawing priority setting.
HPS.CuttingSectionKit HPS.CuttingSectionKit.UnsetUserData | ( | IntPtr | in_index | ) |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
HPS.CuttingSectionKit HPS.CuttingSectionKit.UnsetUserData | ( | IntPtr[] | in_indices | ) |
Removes the user data at the given indices from this kit.
in_count | The size of the following array. |
in_indices | The indices of the user data to remove. |
HPS.CuttingSectionKit HPS.CuttingSectionKit.UnsetVisualization | ( | ) |
Removes the visualization settings for this CuttingSectionKit.