
Public Member Functions | |
CircularArcKit () | |
The default constructor creates an empty CircularArcKit object. More... | |
CircularArcKit (HPS.CircularArcKit in_kit) | |
The copy constructor creates a new CircularArcKit object that contains the same settings as the source CircularArcKit. More... | |
void | Consume (HPS.CircularArcKit in_kit) |
Copies the source CircularArcKit into this CircularArcKit and resets the source kit. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this CircularArcKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.CircularArcKit in_kit) |
Check if the source CircularArcKit is equivalent to this CircularArcKit. More... | |
override int | GetHashCode () |
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.CircularArcKit in_kit) |
Copies the source CircularArcKit into this CircularArcKit. More... | |
HPS.CircularArcKit | SetEnd (HPS.Point in_end) |
Sets the end point for this CircularArcKit. This is the point on the circumference of the circle at which the circular arc ends. More... | |
HPS.CircularArcKit | SetMiddle (HPS.Point in_middle) |
Sets the middle point for this CircularArcKit. This is a point on the circumference of the circle between the start and end points for the circular arc. More... | |
HPS.CircularArcKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the CircularArcKit. 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.CircularArcKit | SetStart (HPS.Point in_start) |
Sets the start point for this CircularArcKit. This is the point on the circumference of the circle at which the circular arc starts. More... | |
HPS.CircularArcKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.CircularArcKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.CircularArcKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
void | Show (out HPS.CircularArcKit out_kit) |
Copies this CircularArcKit into the given CircularArcKit. More... | |
bool | ShowEnd (out HPS.Point out_end) |
Shows the end point for this CircularArcKit. More... | |
bool | ShowMiddle (out HPS.Point out_middle) |
Shows the middle point for this CircularArcKit. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
bool | ShowStart (out HPS.Point out_start) |
Shows the start point for this CircularArcKit. 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.CircularArcKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
HPS.CircularArcKit | UnsetEnd () |
Removes the end point for this CircularArcKit. More... | |
HPS.CircularArcKit | UnsetEverything () |
Removes all settings from the CircularArcKit. More... | |
HPS.CircularArcKit | UnsetMiddle () |
Removes the middle point for this CircularArcKit. More... | |
HPS.CircularArcKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
HPS.CircularArcKit | UnsetStart () |
Removes the start point for this CircularArcKit. More... | |
HPS.CircularArcKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.CircularArcKit | 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.CircularArcKit a, HPS.CircularArcKit b) |
static bool | operator== (HPS.CircularArcKit a, HPS.CircularArcKit 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 CircularArcKit class is a user space object. It is a kit analog to a CircularArcKey.
Constructor & Destructor Documentation
◆ CircularArcKit() [1/2]
|
inline |
The default constructor creates an empty CircularArcKit object.
◆ CircularArcKit() [2/2]
|
inline |
The copy constructor creates a new CircularArcKit object that contains the same settings as the source CircularArcKit.
- Parameters
-
in_kit The source CircularArcKit to copy.
Member Function Documentation
◆ Consume()
|
inline |
Copies the source CircularArcKit into this CircularArcKit and resets the source kit.
- Parameters
-
in_kit The source LineKit to consume.
◆ Empty()
|
inlinevirtual |
Indicates whether this CircularArcKit has any values set on it.
- Returns
- true if no values are set on this CircularArcKit, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
|
inline |
Check if the source CircularArcKit is equivalent to this CircularArcKit.
- Parameters
-
in_kit The source CircularArcKit to compare to this CircularArcKit.
- 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 CircularArcKit into this CircularArcKit.
- Parameters
-
in_kit The source CircularArcKit to copy.
◆ SetEnd()
|
inline |
Sets the end point for this CircularArcKit. This is the point on the circumference of the circle at which the circular arc ends.
- Parameters
-
in_end The end point for this CircularArcKit.
- Returns
- A reference to this CircularArcKit.
◆ SetMiddle()
|
inline |
Sets the middle point for this CircularArcKit. This is a point on the circumference of the circle between the start and end points for the circular arc.
- Parameters
-
in_middle The middle point for this CircularArcKit.
- Returns
- A reference to this CircularArcKit.
◆ SetPriority()
|
inline |
Assigns a specific drawing priority value to the CircularArcKit. 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()
◆ SetStart()
|
inline |
Sets the start point for this CircularArcKit. This is the point on the circumference of the circle at which the circular arc starts.
- Parameters
-
in_start The start point for this CircularArcKit.
- Returns
- A reference to this CircularArcKit.
◆ 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 CircularArcKit into the given CircularArcKit.
- Parameters
-
out_kit The CircularArcKit to populate with the contents of this CircularArcKit.
◆ ShowEnd()
|
inline |
Shows the end point for this CircularArcKit.
- Parameters
-
out_end The end point for this CircularArcKit.
- Returns
- true if an end point was set, false otherwise.
◆ ShowMiddle()
|
inline |
Shows the middle point for this CircularArcKit.
- Parameters
-
out_middle The middle point for this CircularArcKit.
- Returns
- true if a middle 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.
◆ ShowStart()
|
inline |
Shows the start point for this CircularArcKit.
- Parameters
-
out_start The start point for this CircularArcKit.
- Returns
- true if a start point 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.
◆ UnsetEnd()
|
inline |
Removes the end point for this CircularArcKit.
- Returns
- A reference to this CircularArcKit.
◆ UnsetEverything()
|
inline |
Removes all settings from the CircularArcKit.
- Returns
- A reference to this CircularArcKit.
◆ UnsetMiddle()
|
inline |
Removes the middle point for this CircularArcKit.
- Returns
- A reference to this CircularArcKit.
◆ UnsetPriority()
|
inline |
Removes a drawing priority setting.
- Returns
- A reference to this object.
◆ UnsetStart()
|
inline |
Removes the start point for this CircularArcKit.
- Returns
- A reference to this CircularArcKit.
◆ 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.CircularArcKit.cs