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

Public Member Functions

 CircularArcKit ()
 
 CircularArcKit (HPS.CircularArcKit in_kit)
 
void Consume (HPS.CircularArcKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.CircularArcKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.CircularArcKit in_kit)
 
HPS.CircularArcKit SetEnd (HPS.Point in_end)
 
HPS.CircularArcKit SetMiddle (HPS.Point in_middle)
 
HPS.CircularArcKit SetPriority (int in_priority)
 
HPS.CircularArcKit SetStart (HPS.Point in_start)
 
HPS.CircularArcKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.CircularArcKit SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.CircularArcKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
void Show (out HPS.CircularArcKit out_kit)
 
bool ShowEnd (out HPS.Point out_end)
 
bool ShowMiddle (out HPS.Point out_middle)
 
bool ShowPriority (out int out_priority)
 
bool ShowStart (out HPS.Point 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.CircularArcKit UnsetAllUserData ()
 
HPS.CircularArcKit UnsetEnd ()
 
HPS.CircularArcKit UnsetEverything ()
 
HPS.CircularArcKit UnsetMiddle ()
 
HPS.CircularArcKit UnsetPriority ()
 
HPS.CircularArcKit UnsetStart ()
 
HPS.CircularArcKit UnsetUserData (IntPtr in_index)
 
HPS.CircularArcKit 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.CircularArcKit a, HPS.CircularArcKit b)
 
static bool operator== (HPS.CircularArcKit a, HPS.CircularArcKit 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 CircularArcKit class is a user space object. It is a kit analog to a CircularArcKey.

Constructor & Destructor Documentation

◆ CircularArcKit() [1/2]

HPS.CircularArcKit.CircularArcKit ( )
inline

The default constructor creates an empty CircularArcKit object.

◆ CircularArcKit() [2/2]

HPS.CircularArcKit.CircularArcKit ( HPS.CircularArcKit  in_kit)
inline

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

Parameters
in_kitThe source CircularArcKit to copy.

Member Function Documentation

◆ Consume()

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

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

Parameters
in_kitThe source LineKit to consume.

◆ Empty()

override bool HPS.CircularArcKit.Empty ( )
inlinevirtual

Indicates whether this CircularArcKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source CircularArcKit is equivalent to this CircularArcKit.

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

◆ ObjectType()

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

Copies the source CircularArcKit into this CircularArcKit.

Parameters
in_kitThe source CircularArcKit to copy.

◆ SetEnd()

HPS.CircularArcKit HPS.CircularArcKit.SetEnd ( HPS.Point  in_end)
inline

Sets the end point for this CircularArcKit. This is the point on the circumference of the circle at which the circular arc ends.

Parameters
in_endThe end point for this CircularArcKit.
Returns
A reference to this CircularArcKit.

◆ SetMiddle()

HPS.CircularArcKit HPS.CircularArcKit.SetMiddle ( HPS.Point  in_middle)
inline

Sets the middle point for this CircularArcKit. This is a point on the circumference of the circle between the start and end points for the circular arc.

Parameters
in_middleThe middle point for this CircularArcKit.
Returns
A reference to this CircularArcKit.

◆ SetPriority()

HPS.CircularArcKit HPS.CircularArcKit.SetPriority ( int  in_priority)
inline

Assigns a specific drawing priority value to the CircularArcKit. 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.CircularArcKit HPS.CircularArcKit.SetStart ( HPS.Point  in_start)
inline

Sets the start point for this CircularArcKit. This is the point on the circumference of the circle at which the circular arc starts.

Parameters
in_startThe start point for this CircularArcKit.
Returns
A reference to this CircularArcKit.

◆ SetUserData() [1/3]

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

Copies this CircularArcKit into the given CircularArcKit.

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

◆ ShowEnd()

bool HPS.CircularArcKit.ShowEnd ( out HPS.Point  out_end)
inline

Shows the end point for this CircularArcKit.

Parameters
out_endThe end point for this CircularArcKit.
Returns
true if an end point was set, false otherwise.

◆ ShowMiddle()

bool HPS.CircularArcKit.ShowMiddle ( out HPS.Point  out_middle)
inline

Shows the middle point for this CircularArcKit.

Parameters
out_middleThe middle point for this CircularArcKit.
Returns
true if a middle point was set, false otherwise.

◆ ShowPriority()

bool HPS.CircularArcKit.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.CircularArcKit.ShowStart ( out HPS.Point  out_start)
inline

Shows the start point for this CircularArcKit.

Parameters
out_startThe start point for this CircularArcKit.
Returns
true if a start point was set, false otherwise.

◆ ShowUserData() [1/2]

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

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

◆ ShowUserDataIndices()

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

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetEnd()

HPS.CircularArcKit HPS.CircularArcKit.UnsetEnd ( )
inline

Removes the end point for this CircularArcKit.

Returns
A reference to this CircularArcKit.

◆ UnsetEverything()

HPS.CircularArcKit HPS.CircularArcKit.UnsetEverything ( )
inline

Removes all settings from the CircularArcKit.

Returns
A reference to this CircularArcKit.

◆ UnsetMiddle()

HPS.CircularArcKit HPS.CircularArcKit.UnsetMiddle ( )
inline

Removes the middle point for this CircularArcKit.

Returns
A reference to this CircularArcKit.

◆ UnsetPriority()

HPS.CircularArcKit HPS.CircularArcKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetStart()

HPS.CircularArcKit HPS.CircularArcKit.UnsetStart ( )
inline

Removes the start point for this CircularArcKit.

Returns
A reference to this CircularArcKit.

◆ UnsetUserData() [1/2]

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