REFERENCE MANUAL
The EllipseKit class is a user space object. More...
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 () |
This function returns the type the object, as declared. More... | |
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. 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... | |
![]() | |
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... | |
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 () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The EllipseKit class is a user space object.
It is the kit analog to an EllipseKey.
HPS.EllipseKit.EllipseKit | ( | ) |
The default constructor creates an empty EllipseKit object.
HPS.EllipseKit.EllipseKit | ( | HPS.EllipseKit | in_kit | ) |
The copy constructor creates a new EllipseKit object that contains the same settings as the source EllipseKit.
in_kit | The source <ref refid="class_h_p_s_1_1_ellipse_kit" kindref="compound">EllipseKit</ref> to copy. |
void HPS.EllipseKit.Consume | ( | HPS.EllipseKit | in_kit | ) |
Copies the source EllipseKit into this EllipseKit and resets the source kit.
in_kit | The source <ref refid="class_h_p_s_1_1_ellipse_kit" kindref="compound">EllipseKit</ref> to consume. |
|
virtual |
Indicates whether this EllipseKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.EllipseKit.Equals | ( | HPS.EllipseKit | in_kit | ) |
Check if the source EllipseKit is equivalent to this EllipseKit.
in_kit | The source <ref refid="class_h_p_s_1_1_ellipse_kit" kindref="compound">EllipseKit</ref> to compare to this <ref refid="class_h_p_s_1_1_ellipse_kit" kindref="compound">EllipseKit</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.Object.
void HPS.EllipseKit.Set | ( | HPS.EllipseKit | in_kit | ) |
Copies the source EllipseKit into this EllipseKit.
in_kit | The source <ref refid="class_h_p_s_1_1_ellipse_kit" kindref="compound">EllipseKit</ref> to copy. |
HPS.EllipseKit HPS.EllipseKit.SetCenter | ( | HPS.Point | in_center | ) |
Sets the center point for the ellipse.
in_center | The center point for the ellipse. |
HPS.EllipseKit HPS.EllipseKit.SetMajor | ( | HPS.Point | in_major | ) |
Sets the intersection point of the major axis and the ellipse.
in_major | The intersection point of the major axis and the ellipse. |
HPS.EllipseKit HPS.EllipseKit.SetMinor | ( | HPS.Point | in_minor | ) |
Sets the intersection point of the minor axis and the ellipse.
in_minor | The intersection point of the minor axis and the ellipse. |
HPS.EllipseKit 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.
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
SubwindowKit::SetPriority()
HPS.EllipseKit HPS.EllipseKit.SetUserData | ( | IntPtr | in_index, |
ulong | in_bytes, | ||
byte[] | in_data | ||
) |
Sets user data on this kit.
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. |
HPS.EllipseKit HPS.EllipseKit.SetUserData | ( | IntPtr | in_index, |
byte[] | in_data | ||
) |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
HPS.EllipseKit HPS.EllipseKit.SetUserData | ( | IntPtr[] | in_indices, |
byte | in_data[][] | ||
) |
Sets user data on this kit.
in_data | An array of bytes of user data to set. |
void HPS.EllipseKit.Show | ( | out HPS.EllipseKit | out_kit | ) |
Copies this EllipseKit into the given EllipseKit.
out_kit | The <ref refid="class_h_p_s_1_1_ellipse_kit" kindref="compound">EllipseKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_ellipse_kit" kindref="compound">EllipseKit</ref>. |
bool HPS.EllipseKit.ShowCenter | ( | out HPS.Point | out_center | ) |
Shows the center point for the ellipse.
out_center | The center point for the ellipse. |
bool HPS.EllipseKit.ShowMajor | ( | out HPS.Point | out_major | ) |
Shows the intersection point of the major axis and the ellipse.
out_major | The intersection point of the major axis and the ellipse. |
bool HPS.EllipseKit.ShowMinor | ( | out HPS.Point | out_minor | ) |
Shows the intersection point of the minor axis and the ellipse.
out_minor | The intersection point of the minor axis and the ellipse. |
bool HPS.EllipseKit.ShowPriority | ( | out int | out_priority | ) |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
bool HPS.EllipseKit.ShowUserData | ( | IntPtr | in_index, |
out byte[] | out_data | ||
) |
Shows the user data at a given index for this kit.
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
bool HPS.EllipseKit.ShowUserData | ( | out IntPtr[] | out_indices, |
out byte | out_data[][] | ||
) |
Shows all user data for this kit.
out_indices | An array of all user data indices set on this kit. |
ulong HPS.EllipseKit.ShowUserDataCount | ( | ) |
Get the number of user data indices set on this kit.
bool HPS.EllipseKit.ShowUserDataIndices | ( | out IntPtr[] | out_indices | ) |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
HPS.EllipseKit HPS.EllipseKit.UnsetAllUserData | ( | ) |
Removes all user data from this kit.
HPS.EllipseKit HPS.EllipseKit.UnsetCenter | ( | ) |
Removes the center point for the ellipse.
HPS.EllipseKit HPS.EllipseKit.UnsetEverything | ( | ) |
Removes all settings from this EllipseKit.
HPS.EllipseKit HPS.EllipseKit.UnsetMajor | ( | ) |
Removes the intersection point of the major axis and the ellipse.
HPS.EllipseKit HPS.EllipseKit.UnsetMinor | ( | ) |
Removes the intersection point of the minor axis and the ellipse.
HPS.EllipseKit HPS.EllipseKit.UnsetPriority | ( | ) |
Removes a drawing priority setting.
HPS.EllipseKit HPS.EllipseKit.UnsetUserData | ( | IntPtr | in_index | ) |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
HPS.EllipseKit HPS.EllipseKit.UnsetUserData | ( | IntPtr[] | in_indices | ) |
Removes the user data at the given indices from this kit.
in_count | The size of the following array. |
in_indices | The indices of the user data to remove. |