|
void | Consume (HPS.CuttingSectionKit in_kit) |
|
| CuttingSectionKey () |
|
| CuttingSectionKey (HPS.Key in_that) |
|
| CuttingSectionKey (HPS.CuttingSectionKey in_that) |
|
override void | Dispose () |
|
HPS.CuttingSectionKey | EditPlanesByDeletion (ulong in_offset, ulong in_count) |
|
HPS.CuttingSectionKey | EditPlanesByInsertion (ulong in_offset, HPS.Plane[] in_planes) |
|
HPS.CuttingSectionKey | EditPlanesByReplacement (ulong in_offset, HPS.Plane[] in_planes) |
|
ulong | GetPlaneCount () |
|
override HPS.Type | ObjectType () |
|
void | Set (HPS.CuttingSectionKit in_kit) |
|
HPS.CuttingSectionKey | SetPlanes (HPS.Plane in_plane) |
|
HPS.CuttingSectionKey | SetPlanes (HPS.Plane[] in_planes) |
|
HPS.CuttingSectionKey | SetVisualization (HPS.CuttingSection.Mode in_mode, HPS.RGBAColor in_color, float in_scale) |
|
HPS.CuttingSectionKey | 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 | ShowVisualization (out HPS.CuttingSection.Mode out_mode, out HPS.RGBAColor out_color, out float out_scale) |
|
override void | Dispose () |
|
| GeometryKey () |
|
| GeometryKey (HPS.Key in_that) |
|
| GeometryKey (HPS.GeometryKey in_that) |
|
override HPS.Type | ObjectType () |
|
HPS.GeometryKey | SetPriority (int in_priority) |
|
HPS.GeometryKey | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
|
HPS.GeometryKey | SetUserData (IntPtr in_index, byte[] in_data) |
|
HPS.GeometryKey | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
|
bool | ShowBounding (out HPS.BoundingKit out_kit) |
|
bool | ShowPriority (out int out_priority) |
|
ulong | ShowReferrers (out HPS.SegmentKey[] out_segments) |
|
ulong | ShowReferrers (out HPS.ReferenceKey[] out_references) |
|
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) |
|
HPS.GeometryKey | UnsetAllUserData () |
|
HPS.GeometryKey | UnsetPriority () |
|
HPS.GeometryKey | UnsetUserData (IntPtr in_index) |
|
HPS.GeometryKey | UnsetUserData (IntPtr[] in_indices) |
|
virtual void | Assign (HPS.Key in_that) |
|
HPS.Key | CopyTo (HPS.SegmentKey in_destination) |
|
void | Delete () |
|
override void | Dispose () |
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.Key in_that) |
|
ulong | GetHash () |
|
override int | GetHashCode () |
|
bool | HasOwner () |
|
| Key () |
|
| Key (HPS.Key in_that) |
|
| Key (HPS.Control in_control) |
|
void | MoveTo (HPS.SegmentKey in_new_owner) |
|
override HPS.Type | ObjectType () |
|
HPS.SegmentKey | Owner () |
|
HPS.SegmentKey | Up () |
|
virtual bool | Empty () |
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
|
bool | HasType (HPS.Type in_mask) |
|
| Object (HPS.Object that) |
|
virtual void | Reset () |
|
virtual HPS.Type | Type () |
|
|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static bool | operator!= (HPS.Key a, HPS.Key b) |
|
static bool | operator== (HPS.Key a, HPS.Key b) |
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The CuttingSectionKey class is a smart pointer to a database object. It is a handle to a cutting section inserted via SegmentKey.InsertCuttingSection.
◆ CuttingSectionKey() [1/3]
HPS.CuttingSectionKey.CuttingSectionKey |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized CuttingSectionKey object. The Type() function will return Type.None.
◆ CuttingSectionKey() [2/3]
HPS.CuttingSectionKey.CuttingSectionKey |
( |
HPS.Key |
in_that | ) |
|
|
inline |
This constructor creates a CuttingSectionKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a CuttingSection key. Otherwise the copy will fail and the resulting CuttingSectionKey will be invalid.
- Parameters
-
in_that | The source Key to copy. |
◆ CuttingSectionKey() [3/3]
◆ Consume()
Completely replaces all settings on this CuttingSectionKey with those set on the specified kit and resets the kit.
- Parameters
-
◆ EditPlanesByDeletion()
Removes planes from the cutting plane list for this CuttingSectionKey.
- Parameters
-
in_offset | The offset into the cutting planes for this CuttingSectionKey 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 CuttingSectionKey. This value must be such that in_offset+in_count<=cutting_plane_count for the deletion to succeed. |
- Returns
- A reference to this CuttingSectionKey.
◆ EditPlanesByInsertion()
Adds cutting planes to this CuttingSectionKey.
- Parameters
-
in_offset | The offset into the cutting plane list for the CuttingSectionKey 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 CuttingSectionKey.
◆ EditPlanesByReplacement()
Replaces planes in the cutting plane list for this CuttingSectionKey.
- Parameters
-
in_offset | The offset into the cutting plane list for this CuttingSectionKey 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 CuttingSectionKey.
◆ GetPlaneCount()
ulong HPS.CuttingSectionKey.GetPlaneCount |
( |
| ) |
|
|
inline |
◆ ObjectType()
override HPS.Type HPS.CuttingSectionKey.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()
Replace those settings on this CuttingSectionKey with those set on the specified kit.
- Parameters
-
◆ SetPlanes() [1/2]
◆ SetPlanes() [2/2]
◆ SetVisualization() [1/2]
◆ SetVisualization() [2/2]
◆ Show()
◆ ShowPlanes()
bool HPS.CuttingSectionKey.ShowPlanes |
( |
out HPS.Plane [] |
out_planes | ) |
|
|
inline |
Shows the cutting planes for this CuttingSectionKey.
- Parameters
-
- Returns
- true if any cutting planes were set, false otherwise.
◆ ShowVisualization()
Shows the visualization to use for this CuttingSectionKey.
- Parameters
-
- Returns
- true if visualization options were set, false otherwise.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.CuttingSectionKey.cs