The EllipticalArcKit class is a user space object. It is the kit analog to an EllipticalArcKey. More...
Public Member Functions | |
override void | Dispose () |
EllipticalArcKit () | |
The default constructor creates an empty EllipticalArcKit object. More... | |
EllipticalArcKit (HPS.EllipticalArcKit in_kit) | |
The copy constructor creates a new EllipticalArcKit object that contains the same settings as the source EllipticalArcKit. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Consume (HPS.EllipticalArcKit in_kit) |
Copies the source EllipticalArcKit into this EllipticalArcKit and resets the source kit. More... | |
void | Set (HPS.EllipticalArcKit in_kit) |
Copies the source EllipticalArcKit into this EllipticalArcKit. More... | |
void | Show (out HPS.EllipticalArcKit out_kit) |
Copies this EllipticalArcKit into the given EllipticalArcKit. More... | |
override bool | Empty () |
Indicates whether this EllipticalArcKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.EllipticalArcKit in_kit) |
Check if the source EllipticalArcKit is equivalent to this EllipticalArcKit. More... | |
HPS.EllipticalArcKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the EllipticalArcKit. 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.EllipticalArcKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
HPS.EllipticalArcKit | SetCenter (HPS.Point in_center) |
Sets the center point for the ellipse used to define the elliptcal arc. More... | |
HPS.EllipticalArcKit | SetMajor (HPS.Point in_major) |
Sets the intersection point of the major axis and the ellipse used to define the elliptcal arc. More... | |
HPS.EllipticalArcKit | SetMinor (HPS.Point in_minor) |
Sets the intersection point of the minor axis and the ellipse used to define the elliptcal arc. More... | |
HPS.EllipticalArcKit | SetStart (float in_start) |
Sets the normalized parametric value on the ellipse at which the elliptical arc starts. The value should be in the range [0.0f,1.0f] and be smaller than the end value. It is defined such that 0.0f is the point where the major axis intersects the ellipse, and as the value increases it passes through the point at which the minor axis intersects the ellipse (0.25f), and that 1.0f maps to the same point as 0.0f. More... | |
HPS.EllipticalArcKit | SetEnd (float in_end) |
Sets the normalized parametric value on the ellipse at which the elliptical arc ends. The value should be in the range [0.0f,1.0f] and be larger than the start value. It is defined such that 0.0f is the point where the major axis intersects the ellipse, and as the value increases it passes through the point at which the minor axis intersects the ellipse (0.25f), and that 1.0f maps to the same point as 0.0f. More... | |
HPS.EllipticalArcKit | UnsetCenter () |
Removes the center point for the ellipse used to define the elliptical arc. More... | |
HPS.EllipticalArcKit | UnsetMajor () |
Removes the intersection point of the major axis and the ellipse used to define the elliptical arc. More... | |
HPS.EllipticalArcKit | UnsetMinor () |
Removes the intersection point of the minor axis and the ellipse used to define the elliptical arc. More... | |
HPS.EllipticalArcKit | UnsetStart () |
Removes the normalized parametric value on the ellipse at which the elliptical arc starts. More... | |
HPS.EllipticalArcKit | UnsetEnd () |
Removes the normalized parametric value on the ellipse at which the elliptical arc ends. More... | |
HPS.EllipticalArcKit | UnsetEverything () |
Removes all settings from this EllipticalArcKit. More... | |
bool | ShowCenter (out HPS.Point out_center) |
Shows the center point for the ellipse used to define the elliptical arc. More... | |
bool | ShowMajor (out HPS.Point out_major) |
Shows the intersection point of the major axis and the ellipse used to define the elliptcal arc. More... | |
bool | ShowMinor (out HPS.Point out_minor) |
Shows the intersection point of the minor axis and the ellipse used to define the elliptcal arc. More... | |
bool | ShowStart (out float out_start) |
Shows the normalized parametric value on the ellipse at which the elliptical arc starts. More... | |
bool | ShowEnd (out float out_end) |
Shows the normalized parametric value on the ellipse at which the elliptical arc ends. More... | |
HPS.EllipticalArcKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.EllipticalArcKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.EllipticalArcKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
HPS.EllipticalArcKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.EllipticalArcKit | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this kit. More... | |
HPS.EllipticalArcKit | UnsetAllUserData () |
Removes all user data from 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... | |
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... | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object that) | |
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... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Static Public Member Functions | |
static bool | operator== (HPS.EllipticalArcKit a, HPS.EllipticalArcKit b) |
static bool | operator!= (HPS.EllipticalArcKit a, HPS.EllipticalArcKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The EllipticalArcKit class is a user space object. It is the kit analog to an EllipticalArcKey.
|
inline |
The default constructor creates an empty EllipticalArcKit object.
|
inline |
The copy constructor creates a new EllipticalArcKit object that contains the same settings as the source EllipticalArcKit.
in_kit | The source EllipticalArcKit to copy. |
|
inline |
Copies the source EllipticalArcKit into this EllipticalArcKit and resets the source kit.
in_kit | The source EllipticalArcKit to consume. |
|
inlinevirtual |
Indicates whether this EllipticalArcKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source EllipticalArcKit is equivalent to this EllipticalArcKit.
in_kit | The source EllipticalArcKit to compare to this EllipticalArcKit. |
|
inlinevirtual |
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.
|
inline |
Copies the source EllipticalArcKit into this EllipticalArcKit.
in_kit | The source EllipticalArcKit to copy. |
|
inline |
Sets the center point for the ellipse used to define the elliptcal arc.
in_center | The center point for the ellipse used to define the elliptical arc. |
|
inline |
Sets the normalized parametric value on the ellipse at which the elliptical arc ends. The value should be in the range [0.0f,1.0f] and be larger than the start value. It is defined such that 0.0f is the point where the major axis intersects the ellipse, and as the value increases it passes through the point at which the minor axis intersects the ellipse (0.25f), and that 1.0f maps to the same point as 0.0f.
in_end | The noramlized parametric value on the ellipse at which the elliptical arc ends. This value should be in the range [0.0f,1.0f] and be larger than the start value. |
|
inline |
Sets the intersection point of the major axis and the ellipse used to define the elliptcal arc.
in_major | The intersection point of the major axis and the ellipse used to define the elliptical arc. |
|
inline |
Sets the intersection point of the minor axis and the ellipse used to define the elliptcal arc.
in_minor | The intersection point of the minor axis and the ellipse used to define the elliptical arc. |
|
inline |
Assigns a specific drawing priority value to the EllipticalArcKit. 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()
|
inline |
Sets the normalized parametric value on the ellipse at which the elliptical arc starts. The value should be in the range [0.0f,1.0f] and be smaller than the end value. It is defined such that 0.0f is the point where the major axis intersects the ellipse, and as the value increases it passes through the point at which the minor axis intersects the ellipse (0.25f), and that 1.0f maps to the same point as 0.0f.
in_start | The noramlized parametric value on the ellipse at which the elliptical arc starts. This value should be in the range [0.0f,1.0f] and be smaller than the end value. |
|
inline |
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. |
|
inline |
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. |
|
inline |
Sets user data on this kit.
in_indices | An array of user data indices to set. |
in_data | An array of bytes of user data to set. |
|
inline |
Copies this EllipticalArcKit into the given EllipticalArcKit.
out_kit | The EllipticalArcKit to populate with the contents of this EllipticalArcKit. |
|
inline |
Shows the center point for the ellipse used to define the elliptical arc.
out_center | The center point for the ellipse used to define the elliptical arc. |
|
inline |
Shows the normalized parametric value on the ellipse at which the elliptical arc ends.
out_end | The noramlized parametric value on the ellipse at which the elliptical arc ends. |
|
inline |
Shows the intersection point of the major axis and the ellipse used to define the elliptcal arc.
out_major | The intersection point of the major axis and the ellipse used to define the elliptical arc. |
|
inline |
Shows the intersection point of the minor axis and the ellipse used to define the elliptcal arc.
out_minor | The intersection point of the minor axis and the ellipse used to define the elliptical arc. |
|
inline |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
|
inline |
Shows the normalized parametric value on the ellipse at which the elliptical arc starts.
out_start | The noramlized parametric value on the ellipse at which the elliptical arc starts. |
|
inline |
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. |
|
inline |
Shows all user data for this kit.
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. |
|
inline |
Get the number of user data indices set on this kit.
|
inline |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
|
inline |
Removes all user data from this kit.
|
inline |
Removes the center point for the ellipse used to define the elliptical arc.
|
inline |
Removes the normalized parametric value on the ellipse at which the elliptical arc ends.
|
inline |
Removes all settings from this EllipticalArcKit.
|
inline |
Removes the intersection point of the major axis and the ellipse used to define the elliptical arc.
|
inline |
Removes the intersection point of the minor axis and the ellipse used to define the elliptical arc.
|
inline |
Removes a drawing priority setting.
|
inline |
Removes the normalized parametric value on the ellipse at which the elliptical arc starts.
|
inline |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
|
inline |
Removes the user data at the given indices from this kit.
in_indices | The indices of the user data to remove. |