REFERENCE MANUAL
The CuttingSectionKey class is a smart pointer to a database object. More...
Public Member Functions | |
void | Consume (HPS.CuttingSectionKit in_kit) |
Completely replaces all settings on this CuttingSectionKey with those set on the specified kit and resets the kit. More... | |
CuttingSectionKey () | |
The default constructor creates an uninitialized CuttingSectionKey object. More... | |
CuttingSectionKey (HPS.Key in_that) | |
This constructor creates a CuttingSectionKey object that shares the underlying smart-pointer of the source Key. More... | |
CuttingSectionKey (HPS.CuttingSectionKey in_that) | |
This constructor creates a CuttingSectionKey object that shares the underlying smart-pointer of the source Key. More... | |
override void | Dispose () |
HPS.CuttingSectionKey | EditPlanesByDeletion (ulong in_offset, ulong in_count) |
Removes planes from the cutting plane list for this CuttingSectionKey. More... | |
HPS.CuttingSectionKey | EditPlanesByInsertion (ulong in_offset, HPS.Plane[] in_planes) |
Adds cutting planes to this CuttingSectionKey. More... | |
HPS.CuttingSectionKey | EditPlanesByReplacement (ulong in_offset, HPS.Plane[] in_planes) |
Replaces planes in the cutting plane list for this CuttingSectionKey. More... | |
ulong | GetPlaneCount () |
Gets the number of cutting planes for this CuttingSectionKey. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.CuttingSectionKit in_kit) |
Replace those settings on this CuttingSectionKey with those set on the specified kit. More... | |
HPS.CuttingSectionKey | SetPlanes (HPS.Plane in_plane) |
Sets a single cutting plane for this CuttingSectionKey. More... | |
HPS.CuttingSectionKey | SetPlanes (HPS.Plane[] in_planes) |
Sets multiple cutting planes for this CuttingSectionKey. More... | |
HPS.CuttingSectionKey | SetVisualization (HPS.CuttingSection.Mode in_mode, HPS.RGBAColor in_color, float in_scale) |
Sets visualization to use for this CuttingSectionKey. More... | |
HPS.CuttingSectionKey | SetVisualization (HPS.CuttingSection.Mode in_mode, HPS.RGBAColor in_color) |
Sets visualization to use for this CuttingSectionKey. More... | |
void | Show (out HPS.CuttingSectionKit out_kit) |
Copy the contents of this CuttingSectionKey into the specified kit. More... | |
bool | ShowPlanes (out HPS.Plane[] out_planes) |
Shows the cutting planes for this CuttingSectionKey. 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 CuttingSectionKey. More... | |
![]() | |
override void | Dispose () |
GeometryKey () | |
The default constructor creates an uninitialized GeometryKey object. More... | |
GeometryKey (HPS.Key in_that) | |
This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More... | |
GeometryKey (HPS.GeometryKey in_that) | |
This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.GeometryKey | SetPriority (int in_priority) |
Assigns a drawing priority value to the geometry. More... | |
HPS.GeometryKey | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this key. More... | |
HPS.GeometryKey | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this key. More... | |
HPS.GeometryKey | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this key. More... | |
bool | ShowBoundings (out HPS.BoundingKit out_kit) |
Shows the bounding of this geometry. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
ulong | ShowReferrers (out HPS.SegmentKey[] out_segments) |
Shows the all the segments which contain references to this key. More... | |
ulong | ShowReferrers (out HPS.ReferenceKey[] out_references) |
Shows the all the references to this key. More... | |
bool | ShowUserData (IntPtr in_index, out byte[] out_data) |
Shows the user data at a given index for this key. More... | |
bool | ShowUserData (out IntPtr[] out_indices, out byte[][] out_data) |
Shows all user data for this key. More... | |
ulong | ShowUserDataCount () |
Get the number of user data indices set on this key. More... | |
bool | ShowUserDataIndices (out IntPtr[] out_indices) |
Shows the indices of all user data set on this key. More... | |
HPS.GeometryKey | UnsetAllUserData () |
Removes all user data from this key. More... | |
HPS.GeometryKey | UnsetPriority () |
Removes the drawing priority setting. More... | |
HPS.GeometryKey | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this key. More... | |
HPS.GeometryKey | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this key. More... | |
![]() | |
virtual void | Assign (HPS.Key in_that) |
Share the smart-pointer. More... | |
HPS.Key | CopyTo (HPS.SegmentKey in_destination) |
Copies the database object referred to by this key into a segment pointed to by in_destination. More... | |
void | Delete () |
Removes the database object referred to by this key. More... | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Key in_that) |
Determines whether the database objects pointed to by this key and in_that are the same. More... | |
ulong | GetHash () |
Returns a hash code for the key. More... | |
override int | GetHashCode () |
bool | HasOwner () |
| |
Key () | |
An uninitialized key refers to no database object and Type() will return Type::None. More... | |
Key (HPS.Key in_that) | |
Shares a reference to a database object referred to by in_that. More... | |
Key (HPS.Control in_control) | |
Initializes a key tied to the Control in_control. More... | |
void | MoveTo (HPS.SegmentKey in_new_owner) |
Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.SegmentKey | Owner () |
| |
HPS.SegmentKey | Up () |
| |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. 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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
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 |
HandleRef | scptr |
The CuttingSectionKey class is a smart pointer to a database object.
It is a handle to a cutting section inserted via SegmentKey::InsertCuttingSection.
HPS.CuttingSectionKey.CuttingSectionKey | ( | ) |
The default constructor creates an uninitialized CuttingSectionKey object.
The Type() function will return Type::None.
HPS.CuttingSectionKey.CuttingSectionKey | ( | HPS.Key | in_that | ) |
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.
HPS.CuttingSectionKey.CuttingSectionKey | ( | HPS.CuttingSectionKey | in_that | ) |
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.
void HPS.CuttingSectionKey.Consume | ( | HPS.CuttingSectionKit | in_kit | ) |
Completely replaces all settings on this CuttingSectionKey with those set on the specified kit and resets the kit.
in_kit | The kit from which to get the settings to replace on this <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</ref>. |
HPS.CuttingSectionKey HPS.CuttingSectionKey.EditPlanesByDeletion | ( | ulong | in_offset, |
ulong | in_count | ||
) |
Removes planes from the cutting plane list for this CuttingSectionKey.
in_offset | The offset into the cutting planes for this <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</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_key" kindref="compound">CuttingSectionKey</ref>. This value must be such that in_offset+in_count<=cutting_plane_count for the deletion to succeed. |
HPS.CuttingSectionKey HPS.CuttingSectionKey.EditPlanesByInsertion | ( | ulong | in_offset, |
HPS.Plane[] | in_planes | ||
) |
Adds cutting planes to this CuttingSectionKey.
in_offset | The offset into the cutting plane list for the <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</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.CuttingSectionKey HPS.CuttingSectionKey.EditPlanesByReplacement | ( | ulong | in_offset, |
HPS.Plane[] | in_planes | ||
) |
Replaces planes in the cutting plane list for this CuttingSectionKey.
in_offset | The offset into the cutting plane list for this <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</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. |
ulong HPS.CuttingSectionKey.GetPlaneCount | ( | ) |
Gets the number of cutting planes for this CuttingSectionKey.
|
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.CuttingSectionKey.Set | ( | HPS.CuttingSectionKit | in_kit | ) |
Replace those settings on this CuttingSectionKey with those set on the specified kit.
in_kit | The kit from which to get the settings to replace on this <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</ref>. |
HPS.CuttingSectionKey HPS.CuttingSectionKey.SetPlanes | ( | HPS.Plane | in_plane | ) |
Sets a single cutting plane for this CuttingSectionKey.
in_plane | The cutting plane for this <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</ref>. |
HPS.CuttingSectionKey HPS.CuttingSectionKey.SetPlanes | ( | HPS.Plane[] | in_planes | ) |
Sets multiple cutting planes for this CuttingSectionKey.
in_count | Size of the following array. |
in_planes | The cutting planes for this <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</ref>. |
HPS.CuttingSectionKey HPS.CuttingSectionKey.SetVisualization | ( | HPS.CuttingSection.Mode | in_mode, |
HPS.RGBAColor | in_color, | ||
float | in_scale | ||
) |
Sets visualization to use for this CuttingSectionKey.
in_mode | The mode for the <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</ref>. |
in_color | The RGBA color for the <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</ref>. |
in_scale | The scale to apply to the visualization geometry for this <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</ref>. Defaults to 1.0f. |
HPS.CuttingSectionKey HPS.CuttingSectionKey.SetVisualization | ( | HPS.CuttingSection.Mode | in_mode, |
HPS.RGBAColor | in_color | ||
) |
Sets visualization to use for this CuttingSectionKey.
in_mode | The mode for the <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</ref>. |
in_color | The RGBA color for the <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</ref>. |
void HPS.CuttingSectionKey.Show | ( | out HPS.CuttingSectionKit | out_kit | ) |
Copy the contents of this CuttingSectionKey into the specified kit.
out_kit | The kit to populate with the contents of this <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</ref>. |
bool HPS.CuttingSectionKey.ShowPlanes | ( | out HPS.Plane[] | out_planes | ) |
Shows the cutting planes for this CuttingSectionKey.
out_planes | The cutting planes for this <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</ref>. |
bool HPS.CuttingSectionKey.ShowVisualization | ( | out HPS.CuttingSection.Mode | out_mode, |
out HPS.RGBAColor | out_color, | ||
out float | out_scale | ||
) |
Shows the visualization to use for this CuttingSectionKey.
out_mode | The mode for this <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</ref>. |
out_color | The RGBA color for this <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</ref>. |
out_scale | The scale to apply to the visualization geometry for this <ref refid="class_h_p_s_1_1_cutting_section_key" kindref="compound">CuttingSectionKey</ref>. |