Inheritance diagram for HPS.EllipseKit:
HPS.Kit HPS.Object

Public Member Functions

void Consume (HPS.EllipseKit in_kit)
 
override void Dispose ()
 
 EllipseKit ()
 
 EllipseKit (HPS.EllipseKit in_kit)
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.EllipseKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.EllipseKit in_kit)
 
HPS.EllipseKit SetCenter (HPS.Point in_center)
 
HPS.EllipseKit SetMajor (HPS.Point in_major)
 
HPS.EllipseKit SetMinor (HPS.Point in_minor)
 
HPS.EllipseKit SetPriority (int in_priority)
 
HPS.EllipseKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.EllipseKit SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.EllipseKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
void Show (out HPS.EllipseKit out_kit)
 
bool ShowCenter (out HPS.Point out_center)
 
bool ShowMajor (out HPS.Point out_major)
 
bool ShowMinor (out HPS.Point out_minor)
 
bool ShowPriority (out int out_priority)
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 
ulong ShowUserDataCount ()
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 
HPS.EllipseKit UnsetAllUserData ()
 
HPS.EllipseKit UnsetCenter ()
 
HPS.EllipseKit UnsetEverything ()
 
HPS.EllipseKit UnsetMajor ()
 
HPS.EllipseKit UnsetMinor ()
 
HPS.EllipseKit UnsetPriority ()
 
HPS.EllipseKit UnsetUserData (IntPtr in_index)
 
HPS.EllipseKit UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static bool operator!= (HPS.EllipseKit a, HPS.EllipseKit b)
 
static bool operator== (HPS.EllipseKit a, HPS.EllipseKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Kit
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

◆ EllipseKit() [1/2]

HPS.EllipseKit.EllipseKit ( )
inline

The default constructor creates an empty EllipseKit object.

◆ EllipseKit() [2/2]

HPS.EllipseKit.EllipseKit ( HPS.EllipseKit  in_kit)
inline

The copy constructor creates a new EllipseKit object that contains the same settings as the source EllipseKit.

Parameters
in_kitThe source EllipseKit to copy.

Member Function Documentation

◆ Consume()

void HPS.EllipseKit.Consume ( HPS.EllipseKit  in_kit)
inline

Copies the source EllipseKit into this EllipseKit and resets the source kit.

Parameters
in_kitThe source EllipseKit to consume.

◆ Empty()

override bool HPS.EllipseKit.Empty ( )
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.

◆ Equals()

bool HPS.EllipseKit.Equals ( HPS.EllipseKit  in_kit)
inline

Check if the source EllipseKit is equivalent to this EllipseKit.

Parameters
in_kitThe source EllipseKit to compare to this EllipseKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

override HPS.Type HPS.EllipseKit.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()

void HPS.EllipseKit.Set ( HPS.EllipseKit  in_kit)
inline

Copies the source EllipseKit into this EllipseKit.

Parameters
in_kitThe source EllipseKit to copy.

◆ SetCenter()

HPS.EllipseKit HPS.EllipseKit.SetCenter ( HPS.Point  in_center)
inline

Sets the center point for the ellipse.

Parameters
in_centerThe center point for the ellipse.
Returns
A reference to this EllipseKit.

◆ SetMajor()

HPS.EllipseKit HPS.EllipseKit.SetMajor ( HPS.Point  in_major)
inline

Sets the intersection point of the major axis and the ellipse.

Parameters
in_majorThe intersection point of the major axis and the ellipse.
Returns
A reference to this EllipseKit.

◆ SetMinor()

HPS.EllipseKit HPS.EllipseKit.SetMinor ( HPS.Point  in_minor)
inline

Sets the intersection point of the minor axis and the ellipse.

Parameters
in_minorThe intersection point of the minor axis and the ellipse.
Returns
A reference to this EllipseKit.

◆ SetPriority()

HPS.EllipseKit HPS.EllipseKit.SetPriority ( int  in_priority)
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_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.
See also
SubwindowKit.SetPriority()
SubwindowKit.SetRenderingAlgorithm()

◆ SetUserData() [1/3]

HPS.EllipseKit HPS.EllipseKit.SetUserData ( IntPtr  in_index,
ulong  in_bytes,
byte []  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [2/3]

HPS.EllipseKit HPS.EllipseKit.SetUserData ( IntPtr  in_index,
byte []  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [3/3]

HPS.EllipseKit HPS.EllipseKit.SetUserData ( IntPtr []  in_indices,
byte  in_data[][] 
)
inline

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.

◆ Show()

void HPS.EllipseKit.Show ( out HPS.EllipseKit  out_kit)
inline

Copies this EllipseKit into the given EllipseKit.

Parameters
out_kitThe EllipseKit to populate with the contents of this EllipseKit.

◆ ShowCenter()

bool HPS.EllipseKit.ShowCenter ( out HPS.Point  out_center)
inline

Shows the center point for the ellipse.

Parameters
out_centerThe center point for the ellipse.
Returns
true if a center was set, false otherwise.

◆ ShowMajor()

bool HPS.EllipseKit.ShowMajor ( out HPS.Point  out_major)
inline

Shows the intersection point of the major axis and the ellipse.

Parameters
out_majorThe intersection point of the major axis and the ellipse.
Returns
true if an intersection point with the major axis was set, false otherwise.

◆ ShowMinor()

bool HPS.EllipseKit.ShowMinor ( out HPS.Point  out_minor)
inline

Shows the intersection point of the minor axis and the ellipse.

Parameters
out_minorThe intersection point of the minor axis and the ellipse.
Returns
true if an intersection point with the minor axis was set, false otherwise.

◆ ShowPriority()

bool HPS.EllipseKit.ShowPriority ( out int  out_priority)
inline

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if the setting is valid, false otherwise.

◆ ShowUserData() [1/2]

bool HPS.EllipseKit.ShowUserData ( IntPtr  in_index,
out byte []  out_data 
)
inline

Shows the user data at a given index for this kit.

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.

◆ ShowUserData() [2/2]

bool HPS.EllipseKit.ShowUserData ( out IntPtr []  out_indices,
out byte  out_data[][] 
)
inline

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn array of all user data set on this kit.
Returns
true if there is user data on this kit, false otherwise.

◆ ShowUserDataCount()

ulong HPS.EllipseKit.ShowUserDataCount ( )
inline

Get the number of user data indices set on this kit.

◆ ShowUserDataIndices()

bool HPS.EllipseKit.ShowUserDataIndices ( out IntPtr []  out_indices)
inline

Shows the indices of all user data set on this kit.

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.

◆ UnsetAllUserData()

HPS.EllipseKit HPS.EllipseKit.UnsetAllUserData ( )
inline

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetCenter()

HPS.EllipseKit HPS.EllipseKit.UnsetCenter ( )
inline

Removes the center point for the ellipse.

Returns
A reference to this EllipseKit.

◆ UnsetEverything()

HPS.EllipseKit HPS.EllipseKit.UnsetEverything ( )
inline

Removes all settings from this EllipseKit.

Returns
A reference to this EllipseKit.

◆ UnsetMajor()

HPS.EllipseKit HPS.EllipseKit.UnsetMajor ( )
inline

Removes the intersection point of the major axis and the ellipse.

Returns
A reference to this EllipseKit.

◆ UnsetMinor()

HPS.EllipseKit HPS.EllipseKit.UnsetMinor ( )
inline

Removes the intersection point of the minor axis and the ellipse.

Returns
A reference to this EllipseKit.

◆ UnsetPriority()

HPS.EllipseKit HPS.EllipseKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetUserData() [1/2]

HPS.EllipseKit HPS.EllipseKit.UnsetUserData ( IntPtr  in_index)
inline

Removes the user data at the given index from this kit.

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [2/2]

HPS.EllipseKit HPS.EllipseKit.UnsetUserData ( IntPtr []  in_indices)
inline

Removes the user data at the given indices from this kit.

Parameters
in_indicesThe 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