
Public Member Functions | |
void | Consume (HPS.EllipseKit in_kit) |
Copies the source EllipseKit into this EllipseKit and resets the source kit. More... | |
override void | Dispose () |
EllipseKit () | |
The default constructor creates an empty EllipseKit object. More... | |
EllipseKit (HPS.EllipseKit in_kit) | |
The copy constructor creates a new EllipseKit object that contains the same settings as the source EllipseKit. More... | |
override bool | Empty () |
Indicates whether this EllipseKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.EllipseKit in_kit) |
Check if the source EllipseKit is equivalent to this EllipseKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
void | Set (HPS.EllipseKit in_kit) |
Copies the source EllipseKit into this EllipseKit. More... | |
HPS.EllipseKit | SetCenter (HPS.Point in_center) |
Sets the center point for the ellipse. More... | |
HPS.EllipseKit | SetMajor (HPS.Point in_major) |
Sets the intersection point of the major axis and the ellipse. More... | |
HPS.EllipseKit | SetMinor (HPS.Point in_minor) |
Sets the intersection point of the minor axis and the ellipse. More... | |
HPS.EllipseKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the EllipseKit. 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.EllipseKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.EllipseKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.EllipseKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
void | Show (out HPS.EllipseKit out_kit) |
Copies this EllipseKit into the given EllipseKit. More... | |
bool | ShowCenter (out HPS.Point out_center) |
Shows the center point for the ellipse. More... | |
bool | ShowMajor (out HPS.Point out_major) |
Shows the intersection point of the major axis and the ellipse. More... | |
bool | ShowMinor (out HPS.Point out_minor) |
Shows the intersection point of the minor axis and the ellipse. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. 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.EllipseKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
HPS.EllipseKit | UnsetCenter () |
Removes the center point for the ellipse. More... | |
HPS.EllipseKit | UnsetEverything () |
Removes all settings from this EllipseKit. More... | |
HPS.EllipseKit | UnsetMajor () |
Removes the intersection point of the major axis and the ellipse. More... | |
HPS.EllipseKit | UnsetMinor () |
Removes the intersection point of the minor axis and the ellipse. More... | |
HPS.EllipseKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
HPS.EllipseKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.EllipseKit | 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 () |
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.EllipseKit a, HPS.EllipseKit b) |
static bool | operator== (HPS.EllipseKit a, HPS.EllipseKit 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 EllipseKit class is a user space object. It is the kit analog to an EllipseKey.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty EllipseKit object.
|
inline |
The copy constructor creates a new EllipseKit object that contains the same settings as the source EllipseKit.
- Parameters
-
in_kit The source EllipseKit to copy.
Member Function Documentation
|
inline |
Copies the source EllipseKit into this EllipseKit and resets the source kit.
- Parameters
-
in_kit The source EllipseKit to consume.
|
inlinevirtual |
Indicates whether this EllipseKit has any values set on it.
- Returns
- true if no values are set on this EllipseKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source EllipseKit is equivalent to this EllipseKit.
- Parameters
-
in_kit The source EllipseKit to compare to this EllipseKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inline |
Copies the source EllipseKit into this EllipseKit.
- Parameters
-
in_kit The source EllipseKit to copy.
|
inline |
Sets the center point for the ellipse.
- Parameters
-
in_center The center point for the ellipse.
- Returns
- A reference to this EllipseKit.
|
inline |
Sets the intersection point of the major axis and the ellipse.
- Parameters
-
in_major The intersection point of the major axis and the ellipse.
- Returns
- A reference to this EllipseKit.
|
inline |
Sets the intersection point of the minor axis and the ellipse.
- Parameters
-
in_minor The intersection point of the minor axis and the ellipse.
- Returns
- A reference to this EllipseKit.
|
inline |
Assigns a specific drawing priority value to the EllipseKit. 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()
|
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.
|
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.
|
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.
|
inline |
Copies this EllipseKit into the given EllipseKit.
- Parameters
-
out_kit The EllipseKit to populate with the contents of this EllipseKit.
|
inline |
Shows the center point for the ellipse.
- Parameters
-
out_center The center point for the ellipse.
- Returns
- true if a center was set, false otherwise.
|
inline |
Shows the intersection point of the major axis and the ellipse.
- Parameters
-
out_major The intersection point of the major axis and the ellipse.
- Returns
- true if an intersection point with the major axis was set, false otherwise.
|
inline |
Shows the intersection point of the minor axis and the ellipse.
- Parameters
-
out_minor The intersection point of the minor axis and the ellipse.
- Returns
- true if an intersection point with the minor axis was set, false otherwise.
|
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.
|
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.
|
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.
|
inline |
Get the number of user data indices set on this kit.
|
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.
|
inline |
Removes all user data from this kit.
- Returns
- A reference to this kit.
|
inline |
Removes the center point for the ellipse.
- Returns
- A reference to this EllipseKit.
|
inline |
Removes all settings from this EllipseKit.
- Returns
- A reference to this EllipseKit.
|
inline |
Removes the intersection point of the major axis and the ellipse.
- Returns
- A reference to this EllipseKit.
|
inline |
Removes the intersection point of the minor axis and the ellipse.
- Returns
- A reference to this EllipseKit.
|
inline |
Removes a drawing priority setting.
- Returns
- A reference to this object.
|
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.
|
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.EllipseKit.cs