
Public Member Functions | |
void | Consume (HPS.InfiniteLineKit in_kit) |
Copies the source InfiniteLineKit into this InfiniteLineKit and resets the source kit. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this InfiniteLineKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.InfiniteLineKit in_kit) |
Check if the source InfiniteLineKit is equivalent to this InfiniteLineKit. More... | |
override int | GetHashCode () |
InfiniteLineKit () | |
The default constructor creates an empty InfiniteLineKit object. More... | |
InfiniteLineKit (HPS.InfiniteLineKit in_kit) | |
The copy constructor creates a new InfiniteLineKit object that contains the same settings as the source InfiniteLineKit. More... | |
override HPS.Type | ObjectType () |
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). More... | |
void | Set (HPS.InfiniteLineKit in_kit) |
Copies the source InfiniteLineKit into this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | SetFirst (HPS.Point in_first) |
Sets the first point for this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the InfiniteLineKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority. More... | |
HPS.InfiniteLineKit | SetSecond (HPS.Point in_second) |
Sets the second point for this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | SetType (HPS.InfiniteLine.Type in_type) |
Sets the type of this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.InfiniteLineKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.InfiniteLineKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
void | Show (out HPS.InfiniteLineKit out_kit) |
Copies this InfiniteLineKit into the given InfiniteLineKit. More... | |
bool | ShowFirst (out HPS.Point out_first) |
Shows the first point for this InfiniteLineKit. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
bool | ShowSecond (out HPS.Point out_second) |
Shows the second point for this InfiniteLineKit. More... | |
bool | ShowType (out HPS.InfiniteLine.Type out_type) |
Shows the type of this InfiniteLineKit. 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... | |
HPS.InfiniteLineKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
HPS.InfiniteLineKit | UnsetEverything () |
Removes all settings from the InfiniteLineKit. More... | |
HPS.InfiniteLineKit | UnsetFirst () |
Removes the first point for this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
HPS.InfiniteLineKit | UnsetSecond () |
Removes the second point for this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | UnsetType () |
Removes the type of this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.InfiniteLineKit | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this kit. More... | |
![]() | |
override void | Dispose () |
Kit (HPS.Kit in_that) | |
override HPS.Type | ObjectType () |
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). More... | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.InfiniteLineKit a, HPS.InfiniteLineKit b) |
static bool | operator== (HPS.InfiniteLineKit a, HPS.InfiniteLineKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The InfiniteLineKit class is a user space object. It is a kit analog to an InfiniteLineKey.
Constructor & Destructor Documentation
◆ InfiniteLineKit() [1/2]
|
inline |
The default constructor creates an empty InfiniteLineKit object.
◆ InfiniteLineKit() [2/2]
|
inline |
The copy constructor creates a new InfiniteLineKit object that contains the same settings as the source InfiniteLineKit.
- Parameters
-
in_kit The source InfiniteLineKit to copy.
Member Function Documentation
◆ Consume()
|
inline |
Copies the source InfiniteLineKit into this InfiniteLineKit and resets the source kit.
- Parameters
-
in_kit The source InfiniteLineKit to consume.
◆ Empty()
|
inlinevirtual |
Indicates whether this InfiniteLineKit has any values set on it.
- Returns
- true if no values are set on this InfiniteLineKit, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
|
inline |
Check if the source InfiniteLineKit is equivalent to this InfiniteLineKit.
- Parameters
-
in_kit The source InfiniteLineKit to compare to this InfiniteLineKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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()
|
inline |
Copies the source InfiniteLineKit into this InfiniteLineKit.
- Parameters
-
in_kit The source InfiniteLineKit to copy.
◆ SetFirst()
|
inline |
Sets the first point for this InfiniteLineKit.
- Parameters
-
in_first The first point for this InfiniteLineKit. If the type is InfiniteLine.Type.Ray, this will be the point at which the ray starts.
- Returns
- A reference to this InfiniteLineKit.
◆ SetPriority()
|
inline |
Assigns a specific drawing priority value to the InfiniteLineKit. 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()
◆ SetSecond()
|
inline |
Sets the second point for this InfiniteLineKit.
- Parameters
-
in_second The second point for this InfiniteLineKit. If the type is InfiniteLine.Type.Ray, this will be the point through which the ray passes.
- Returns
- A reference to this InfiniteLineKit.
◆ SetType()
|
inline |
Sets the type of this InfiniteLineKit.
- Parameters
-
in_type The type of this InfiniteLineKit.
- Returns
- A reference to this InfiniteLineKit.
◆ SetUserData() [1/3]
|
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]
|
inline |
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]
|
inline |
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.
◆ Show()
|
inline |
Copies this InfiniteLineKit into the given InfiniteLineKit.
- Parameters
-
out_kit The InfiniteLineKit to populate with the contents of this InfiniteLineKit.
◆ ShowFirst()
|
inline |
Shows the first point for this InfiniteLineKit.
- Parameters
-
out_first The first point for this InfiniteLineKit.
- Returns
- true if a first point was set, false otherwise.
◆ ShowPriority()
|
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.
◆ ShowSecond()
|
inline |
Shows the second point for this InfiniteLineKit.
- Parameters
-
out_second The second point for this InfiniteLineKit.
- Returns
- true if a second point was set, false otherwise.
◆ ShowType()
|
inline |
Shows the type of this InfiniteLineKit.
- Parameters
-
out_type The type of this InfiniteLineKit.
- Returns
- true if a type was set, false otherwise.
◆ ShowUserData() [1/2]
|
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]
|
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()
|
inline |
Get the number of user data indices set on this kit.
◆ ShowUserDataIndices()
|
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.
◆ UnsetAllUserData()
|
inline |
Removes all user data from this kit.
- Returns
- A reference to this kit.
◆ UnsetEverything()
|
inline |
Removes all settings from the InfiniteLineKit.
- Returns
- A reference to this InfiniteLineKit.
◆ UnsetFirst()
|
inline |
Removes the first point for this InfiniteLineKit.
- Returns
- A reference to this InfiniteLineKit.
◆ UnsetPriority()
|
inline |
Removes a drawing priority setting.
- Returns
- A reference to this object.
◆ UnsetSecond()
|
inline |
Removes the second point for this InfiniteLineKit.
- Returns
- A reference to this InfiniteLineKit.
◆ UnsetType()
|
inline |
Removes the type of this InfiniteLineKit.
- Returns
- A reference to this InfiniteLineKit.
◆ UnsetUserData() [1/2]
|
inline |
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]
|
inline |
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.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.InfiniteLineKit.cs