REFERENCE MANUAL
The InfiniteLineKey class is a smart pointer to a database object. More...
Public Member Functions | |
void | Consume (HPS.InfiniteLineKit in_kit) |
Completely replaces all settings on this InfiniteLineKey with those set on the specified kit and resets the kit. More... | |
override void | Dispose () |
InfiniteLineKey () | |
The default constructor creates an uninitialized InfiniteLineKey object. More... | |
InfiniteLineKey (HPS.Key in_that) | |
This constructor creates an InfiniteLineKey object that shares the underlying smart-pointer of the source Key. More... | |
InfiniteLineKey (HPS.InfiniteLineKey in_that) | |
This constructor creates an InfiniteLineKey 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... | |
void | Set (HPS.InfiniteLineKit in_kit) |
Replace those settings on this InfiniteLineKey with those set on the specified kit. More... | |
HPS.InfiniteLineKey | SetFirst (HPS.Point in_first) |
Sets the first point for this InfiniteLineKey. More... | |
HPS.InfiniteLineKey | SetSecond (HPS.Point in_second) |
Sets the second point for this InfiniteLineKey. More... | |
HPS.InfiniteLineKey | SetType (HPS.InfiniteLine.Type in_type) |
Sets the type of this InfiniteLineKey. More... | |
void | Show (out HPS.InfiniteLineKit out_kit) |
Copy the contents of this InfiniteLineKey into the specified kit. More... | |
bool | ShowFirst (out HPS.Point out_first) |
Shows the first point for this InfiniteLineKey. More... | |
bool | ShowSecond (out HPS.Point out_second) |
Shows the second point for this InfiniteLineKey. More... | |
bool | ShowType (out HPS.InfiniteLine.Type out_type) |
Shows the type of this InfiniteLineKey. More... | |
![]() | |
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... | |
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 () |
![]() | |
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 InfiniteLineKey class is a smart pointer to a database object.
It is a handle to an infinite line or ray inserted via SegmentKey::InsertInfiniteLine.
HPS.InfiniteLineKey.InfiniteLineKey | ( | ) |
The default constructor creates an uninitialized InfiniteLineKey object.
The Type() function will return Type::None.
HPS.InfiniteLineKey.InfiniteLineKey | ( | HPS.Key | in_that | ) |
This constructor creates an InfiniteLineKey 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 an InfiniteLine key. Otherwise the copy will fail and the resulting InfiniteLineKey will be invalid.
HPS.InfiniteLineKey.InfiniteLineKey | ( | HPS.InfiniteLineKey | in_that | ) |
This constructor creates an InfiniteLineKey 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 an InfiniteLine key. Otherwise the copy will fail and the resulting InfiniteLineKey will be invalid.
void HPS.InfiniteLineKey.Consume | ( | HPS.InfiniteLineKit | in_kit | ) |
Completely replaces all settings on this InfiniteLineKey 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_infinite_line_key" kindref="compound">InfiniteLineKey</ref>. |
|
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.GeometryKey.
void HPS.InfiniteLineKey.Set | ( | HPS.InfiniteLineKit | in_kit | ) |
Replace those settings on this InfiniteLineKey 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_infinite_line_key" kindref="compound">InfiniteLineKey</ref>. |
HPS.InfiniteLineKey HPS.InfiniteLineKey.SetFirst | ( | HPS.Point | in_first | ) |
Sets the first point for this InfiniteLineKey.
in_first | The first point for this <ref refid="class_h_p_s_1_1_infinite_line_key" kindref="compound">InfiniteLineKey</ref>. If the type is <ref refid="class_h_p_s_1_1_infinite_line_1a31697425b57e23592898ea6f892ca3cca9406e3c325bfc9873426e5eda4ba6e18" kindref="member">InfiniteLine::Type::Ray</ref>, this will be the point at which the ray starts. |
HPS.InfiniteLineKey HPS.InfiniteLineKey.SetSecond | ( | HPS.Point | in_second | ) |
Sets the second point for this InfiniteLineKey.
in_second | The second point for this <ref refid="class_h_p_s_1_1_infinite_line_key" kindref="compound">InfiniteLineKey</ref>. If the type is <ref refid="class_h_p_s_1_1_infinite_line_1a31697425b57e23592898ea6f892ca3cca9406e3c325bfc9873426e5eda4ba6e18" kindref="member">InfiniteLine::Type::Ray</ref>, this will be the point through which the ray passes. |
HPS.InfiniteLineKey HPS.InfiniteLineKey.SetType | ( | HPS.InfiniteLine.Type | in_type | ) |
Sets the type of this InfiniteLineKey.
in_type | The type of this <ref refid="class_h_p_s_1_1_infinite_line_key" kindref="compound">InfiniteLineKey</ref>. |
void HPS.InfiniteLineKey.Show | ( | out HPS.InfiniteLineKit | out_kit | ) |
Copy the contents of this InfiniteLineKey into the specified kit.
out_kit | The kit to populate with the contents of this <ref refid="class_h_p_s_1_1_infinite_line_key" kindref="compound">InfiniteLineKey</ref>. |
bool HPS.InfiniteLineKey.ShowFirst | ( | out HPS.Point | out_first | ) |
Shows the first point for this InfiniteLineKey.
out_first | The first point for this <ref refid="class_h_p_s_1_1_infinite_line_key" kindref="compound">InfiniteLineKey</ref>. |
bool HPS.InfiniteLineKey.ShowSecond | ( | out HPS.Point | out_second | ) |
Shows the second point for this InfiniteLineKey.
out_second | The second point for this <ref refid="class_h_p_s_1_1_infinite_line_key" kindref="compound">InfiniteLineKey</ref>. |
bool HPS.InfiniteLineKey.ShowType | ( | out HPS.InfiniteLine.Type | out_type | ) |
Shows the type of this InfiniteLineKey.
out_type | The type of this <ref refid="class_h_p_s_1_1_infinite_line_key" kindref="compound">InfiniteLineKey</ref>. |