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

Public Member Functions

void Consume (HPS.EllipticalArcKit in_kit)
 
override void Dispose ()
 
 EllipticalArcKit ()
 
 EllipticalArcKit (HPS.EllipticalArcKit in_kit)
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.EllipticalArcKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.EllipticalArcKit in_kit)
 
HPS.EllipticalArcKit SetCenter (HPS.Point in_center)
 
HPS.EllipticalArcKit SetEnd (float in_end)
 
HPS.EllipticalArcKit SetMajor (HPS.Point in_major)
 
HPS.EllipticalArcKit SetMinor (HPS.Point in_minor)
 
HPS.EllipticalArcKit SetPriority (int in_priority)
 
HPS.EllipticalArcKit SetStart (float in_start)
 
HPS.EllipticalArcKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.EllipticalArcKit SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.EllipticalArcKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
void Show (out HPS.EllipticalArcKit out_kit)
 
bool ShowCenter (out HPS.Point out_center)
 
bool ShowEnd (out float out_end)
 
bool ShowMajor (out HPS.Point out_major)
 
bool ShowMinor (out HPS.Point out_minor)
 
bool ShowPriority (out int out_priority)
 
bool ShowStart (out float out_start)
 
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.EllipticalArcKit UnsetAllUserData ()
 
HPS.EllipticalArcKit UnsetCenter ()
 
HPS.EllipticalArcKit UnsetEnd ()
 
HPS.EllipticalArcKit UnsetEverything ()
 
HPS.EllipticalArcKit UnsetMajor ()
 
HPS.EllipticalArcKit UnsetMinor ()
 
HPS.EllipticalArcKit UnsetPriority ()
 
HPS.EllipticalArcKit UnsetStart ()
 
HPS.EllipticalArcKit UnsetUserData (IntPtr in_index)
 
HPS.EllipticalArcKit 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.EllipticalArcKit a, HPS.EllipticalArcKit b)
 
static bool operator== (HPS.EllipticalArcKit a, HPS.EllipticalArcKit 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 EllipticalArcKit class is a user space object. It is the kit analog to an EllipticalArcKey.

Constructor & Destructor Documentation

◆ EllipticalArcKit() [1/2]

HPS.EllipticalArcKit.EllipticalArcKit ( )
inline

The default constructor creates an empty EllipticalArcKit object.

◆ EllipticalArcKit() [2/2]

HPS.EllipticalArcKit.EllipticalArcKit ( HPS.EllipticalArcKit  in_kit)
inline

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

Parameters
in_kitThe source EllipticalArcKit to copy.

Member Function Documentation

◆ Consume()

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

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

Parameters
in_kitThe source EllipticalArcKit to consume.

◆ Empty()

override bool HPS.EllipticalArcKit.Empty ( )
inlinevirtual

Indicates whether this EllipticalArcKit has any values set on it.

Returns
true if no values are set on this EllipticalArcKit, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source EllipticalArcKit is equivalent to this EllipticalArcKit.

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

◆ ObjectType()

override HPS.Type HPS.EllipticalArcKit.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.EllipticalArcKit.Set ( HPS.EllipticalArcKit  in_kit)
inline

Copies the source EllipticalArcKit into this EllipticalArcKit.

Parameters
in_kitThe source EllipticalArcKit to copy.

◆ SetCenter()

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

Sets the center point for the ellipse used to define the elliptcal arc.

Parameters
in_centerThe center point for the ellipse used to define the elliptical arc.
Returns
A reference to this EllipticalArcKit.

◆ SetEnd()

HPS.EllipticalArcKit HPS.EllipticalArcKit.SetEnd ( float  in_end)
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.

Parameters
in_endThe 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.
Returns
A reference to this EllipticalArcKit.

◆ SetMajor()

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

Sets the intersection point of the major axis and the ellipse used to define the elliptcal arc.

Parameters
in_majorThe intersection point of the major axis and the ellipse used to define the elliptical arc.
Returns
A reference to this EllipticalArcKit.

◆ SetMinor()

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

Sets the intersection point of the minor axis and the ellipse used to define the elliptcal arc.

Parameters
in_minorThe intersection point of the minor axis and the ellipse used to define the elliptical arc.
Returns
A reference to this EllipticalArcKit.

◆ SetPriority()

HPS.EllipticalArcKit HPS.EllipticalArcKit.SetPriority ( int  in_priority)
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.

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()

◆ SetStart()

HPS.EllipticalArcKit HPS.EllipticalArcKit.SetStart ( float  in_start)
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.

Parameters
in_startThe 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.
Returns
A reference to this EllipticalArcKit.

◆ SetUserData() [1/3]

HPS.EllipticalArcKit HPS.EllipticalArcKit.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.EllipticalArcKit HPS.EllipticalArcKit.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.EllipticalArcKit HPS.EllipticalArcKit.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.EllipticalArcKit.Show ( out HPS.EllipticalArcKit  out_kit)
inline

Copies this EllipticalArcKit into the given EllipticalArcKit.

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

◆ ShowCenter()

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

Shows the center point for the ellipse used to define the elliptical arc.

Parameters
out_centerThe center point for the ellipse used to define the elliptical arc.
Returns
true if a center was set, false otherwise.

◆ ShowEnd()

bool HPS.EllipticalArcKit.ShowEnd ( out float  out_end)
inline

Shows the normalized parametric value on the ellipse at which the elliptical arc ends.

Parameters
out_endThe noramlized parametric value on the ellipse at which the elliptical arc ends.
Returns
true if a normalized parametric end value was set, false otherwise.

◆ ShowMajor()

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

Shows the intersection point of the major axis and the ellipse used to define the elliptcal arc.

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

◆ ShowMinor()

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

Shows the intersection point of the minor axis and the ellipse used to define the elliptcal arc.

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

◆ ShowPriority()

bool HPS.EllipticalArcKit.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.

◆ ShowStart()

bool HPS.EllipticalArcKit.ShowStart ( out float  out_start)
inline

Shows the normalized parametric value on the ellipse at which the elliptical arc starts.

Parameters
out_startThe noramlized parametric value on the ellipse at which the elliptical arc starts.
Returns
true if a normalized parametric start value was set, false otherwise.

◆ ShowUserData() [1/2]

bool HPS.EllipticalArcKit.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.EllipticalArcKit.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.EllipticalArcKit.ShowUserDataCount ( )
inline

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

◆ ShowUserDataIndices()

bool HPS.EllipticalArcKit.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.EllipticalArcKit HPS.EllipticalArcKit.UnsetAllUserData ( )
inline

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetCenter()

HPS.EllipticalArcKit HPS.EllipticalArcKit.UnsetCenter ( )
inline

Removes the center point for the ellipse used to define the elliptical arc.

Returns
A reference to this EllipticalArcKit.

◆ UnsetEnd()

HPS.EllipticalArcKit HPS.EllipticalArcKit.UnsetEnd ( )
inline

Removes the normalized parametric value on the ellipse at which the elliptical arc ends.

Returns
A reference to this EllipticalArcKit.

◆ UnsetEverything()

HPS.EllipticalArcKit HPS.EllipticalArcKit.UnsetEverything ( )
inline

Removes all settings from this EllipticalArcKit.

Returns
A reference to this EllipticalArcKit.

◆ UnsetMajor()

HPS.EllipticalArcKit HPS.EllipticalArcKit.UnsetMajor ( )
inline

Removes the intersection point of the major axis and the ellipse used to define the elliptical arc.

Returns
A reference to this EllipticalArcKit.

◆ UnsetMinor()

HPS.EllipticalArcKit HPS.EllipticalArcKit.UnsetMinor ( )
inline

Removes the intersection point of the minor axis and the ellipse used to define the elliptical arc.

Returns
A reference to this EllipticalArcKit.

◆ UnsetPriority()

HPS.EllipticalArcKit HPS.EllipticalArcKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetStart()

HPS.EllipticalArcKit HPS.EllipticalArcKit.UnsetStart ( )
inline

Removes the normalized parametric value on the ellipse at which the elliptical arc starts.

Returns
A reference to this EllipticalArcKit.

◆ UnsetUserData() [1/2]

HPS.EllipticalArcKit HPS.EllipticalArcKit.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.EllipticalArcKit HPS.EllipticalArcKit.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.EllipticalArcKit.cs