|
void | Consume (HPS.CuttingSectionKit in_kit) |
|
| CuttingSectionKit () |
|
| CuttingSectionKit (HPS.CuttingSectionKit in_kit) |
|
override void | Dispose () |
|
HPS.CuttingSectionKit | EditPlanesByDeletion (ulong in_offset, ulong in_count) |
|
HPS.CuttingSectionKit | EditPlanesByInsertion (ulong in_offset, HPS.Plane[] in_planes) |
|
HPS.CuttingSectionKit | EditPlanesByReplacement (ulong in_offset, HPS.Plane[] in_planes) |
|
override bool | Empty () |
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.CuttingSectionKit in_kit) |
|
override int | GetHashCode () |
|
ulong | GetPlaneCount () |
|
override HPS.Type | ObjectType () |
|
void | Set (HPS.CuttingSectionKit in_kit) |
|
HPS.CuttingSectionKit | SetPlanes (HPS.Plane in_plane) |
|
HPS.CuttingSectionKit | SetPlanes (HPS.Plane[] in_planes) |
|
HPS.CuttingSectionKit | SetPriority (int in_priority) |
|
HPS.CuttingSectionKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
|
HPS.CuttingSectionKit | SetUserData (IntPtr in_index, byte[] in_data) |
|
HPS.CuttingSectionKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
|
HPS.CuttingSectionKit | SetVisualization (HPS.CuttingSection.Mode in_mode, HPS.RGBAColor in_color, float in_scale) |
|
HPS.CuttingSectionKit | SetVisualization (HPS.CuttingSection.Mode in_mode, HPS.RGBAColor in_color) |
|
void | Show (out HPS.CuttingSectionKit out_kit) |
|
bool | ShowPlanes (out HPS.Plane[] out_planes) |
|
bool | ShowPriority (out int out_priority) |
|
bool | ShowUserData (IntPtr in_index, out byte[] out_data) |
|
bool | ShowUserData (out IntPtr[] out_indices, out byte[][] out_data) |
|
ulong | ShowUserDataCount () |
|
bool | ShowUserDataIndices (out IntPtr[] out_indices) |
|
bool | ShowVisualization (out HPS.CuttingSection.Mode out_mode, out HPS.RGBAColor out_color, out float out_scale) |
|
HPS.CuttingSectionKit | UnsetAllUserData () |
|
HPS.CuttingSectionKit | UnsetEverything () |
|
HPS.CuttingSectionKit | UnsetPlanes () |
|
HPS.CuttingSectionKit | UnsetPriority () |
|
HPS.CuttingSectionKit | UnsetUserData (IntPtr in_index) |
|
HPS.CuttingSectionKit | UnsetUserData (IntPtr[] in_indices) |
|
HPS.CuttingSectionKit | UnsetVisualization () |
|
override void | Dispose () |
|
| Kit (HPS.Kit in_that) |
|
override HPS.Type | ObjectType () |
|
override HPS.Type | Type () |
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
|
bool | HasType (HPS.Type in_mask) |
|
| Object (HPS.Object that) |
|
virtual void | Reset () |
|
|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The CuttingSectionKit class is a user space object. It is a kit analog to a CuttingSectionKey.
◆ CuttingSectionKit() [1/2]
HPS.CuttingSectionKit.CuttingSectionKit |
( |
| ) |
|
|
inline |
◆ CuttingSectionKit() [2/2]
◆ Consume()
◆ EditPlanesByDeletion()
Removes planes from the cutting plane list for this CuttingSectionKit.
- Parameters
-
in_offset | The offset into the cutting planes for this CuttingSectionKit 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 CuttingSectionKit. This value must be such that in_offset+in_count<=cutting_plane_count for the deletion to succeed. |
- Returns
- A reference to this CuttingSectionKit.
◆ EditPlanesByInsertion()
Adds cutting planes to this CuttingSectionKit.
- Parameters
-
in_offset | The offset into the cutting plane list for the CuttingSectionKit at which to insert planes. This value must be such that in_offset<cutting_plane_count for insertion to succeed. |
in_planes | The planes to insert into the cutting plane list at the specified offset. |
- Returns
- A reference to this CuttingSectionKit.
◆ EditPlanesByReplacement()
Replaces planes in the cutting plane list for this CuttingSectionKit.
- Parameters
-
in_offset | The offset into the cutting plane list for this CuttingSectionKit at which to start replacing planes. This value must be such that in_offset<cutting_plane_count for replacement to succeed. |
in_planes | The planes to use to replace those in the cutting plane list at the specified offset. The size of this array must be such that in_offset+in_planes.size()<=cutting_plane_count for the replacement to succeed. |
- Returns
- A reference to this CuttingSectionKit.
◆ Empty()
override bool HPS.CuttingSectionKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
◆ GetPlaneCount()
ulong HPS.CuttingSectionKit.GetPlaneCount |
( |
| ) |
|
|
inline |
◆ ObjectType()
override HPS.Type HPS.CuttingSectionKit.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
◆ Set()
◆ SetPlanes() [1/2]
◆ SetPlanes() [2/2]
◆ SetPriority()
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.
- Parameters
-
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
- Returns
- A reference to this object.
SubwindowKit.SetPriority()
SubwindowKit.SetRenderingAlgorithm()
◆ SetUserData() [1/3]
HPS.CuttingSectionKit HPS.CuttingSectionKit.SetUserData |
( |
IntPtr |
in_index, |
|
|
ulong |
in_bytes, |
|
|
byte [] |
in_data |
|
) |
| |
|
inline |
Sets user data on this kit.
- Parameters
-
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. |
- Returns
- A reference to this kit.
◆ SetUserData() [2/3]
Sets user data on this kit.
- Parameters
-
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
- Returns
- A reference to this kit.
◆ SetUserData() [3/3]
Sets user data on this kit.
- Parameters
-
in_indices | An array of user data indices to set. |
in_data | An array of bytes of user data to set. |
- Returns
- A reference to this kit.
◆ SetVisualization() [1/2]
◆ SetVisualization() [2/2]
◆ Show()
◆ ShowPlanes()
bool HPS.CuttingSectionKit.ShowPlanes |
( |
out HPS.Plane [] |
out_planes | ) |
|
|
inline |
Shows the cutting planes for this CuttingSectionKit.
- Parameters
-
- Returns
- true if any cutting planes were set, false otherwise.
◆ ShowPriority()
bool HPS.CuttingSectionKit.ShowPriority |
( |
out int |
out_priority | ) |
|
|
inline |
Shows the drawing priority.
- Parameters
-
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowUserData() [1/2]
bool HPS.CuttingSectionKit.ShowUserData |
( |
IntPtr |
in_index, |
|
|
out byte [] |
out_data |
|
) |
| |
|
inline |
Shows the user data at a given index for this kit.
- Parameters
-
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
- Returns
- true if there is user data at the given index, false otherwise.
◆ ShowUserData() [2/2]
bool HPS.CuttingSectionKit.ShowUserData |
( |
out IntPtr [] |
out_indices, |
|
|
out byte |
out_data[][] |
|
) |
| |
|
inline |
Shows all user data for this kit.
- Parameters
-
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. |
- Returns
- true if there is user data on this kit, false otherwise.
◆ ShowUserDataCount()
ulong HPS.CuttingSectionKit.ShowUserDataCount |
( |
| ) |
|
|
inline |
Get the number of user data indices set on this kit.
◆ ShowUserDataIndices()
bool HPS.CuttingSectionKit.ShowUserDataIndices |
( |
out IntPtr [] |
out_indices | ) |
|
|
inline |
Shows the indices of all user data set on this kit.
- Parameters
-
out_indices | The user data indices set on this kit. |
- Returns
- The number of user data indices set on this kit.
◆ ShowVisualization()
Shows the visualization to use for this CuttingSectionKit.
- Parameters
-
- Returns
- true if visualization options were set, false otherwise.
◆ UnsetAllUserData()
Removes all user data from this kit.
- Returns
- A reference to this kit.
◆ UnsetEverything()
◆ UnsetPlanes()
◆ UnsetPriority()
Removes a drawing priority setting.
- Returns
- A reference to this object.
◆ UnsetUserData() [1/2]
Removes the user data at the given index from this kit.
- Parameters
-
in_index | The index of the user data to remove. |
- Returns
- A reference to this kit.
◆ UnsetUserData() [2/2]
Removes the user data at the given indices from this kit.
- Parameters
-
in_indices | The indices of the user data to remove. |
- Returns
- A reference to this kit.
◆ UnsetVisualization()
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.CuttingSectionKit.cs