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

Public Member Functions

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

Constructor & Destructor Documentation

◆ CircularWedgeKit() [1/2]

HPS.CircularWedgeKit.CircularWedgeKit ( )
inline

The default constructor creates an empty CircularWedgeKit object.

◆ CircularWedgeKit() [2/2]

HPS.CircularWedgeKit.CircularWedgeKit ( HPS.CircularWedgeKit  in_kit)
inline

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

Parameters
in_kitThe source CircularWedgeKit to copy.

Member Function Documentation

◆ Consume()

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

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

Parameters
in_kitThe source CircularWedgeKit to consume.

◆ Empty()

override bool HPS.CircularWedgeKit.Empty ( )
inlinevirtual

Indicates whether this CircularWedgeKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source CircularWedgeKit is equivalent to this CircularWedgeKit.

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

◆ ObjectType()

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

Copies the source CircularWedgeKit into this CircularWedgeKit.

Parameters
in_kitThe source CircularWedgeKit to copy.

◆ SetEnd()

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

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

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

◆ SetMiddle()

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

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

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

◆ SetPriority()

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

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

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

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

◆ SetUserData() [1/3]

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

Copies this CircularWedgeKit into the given CircularWedgeKit.

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

◆ ShowEnd()

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

Shows the end point for this CircularWedgeKit.

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

◆ ShowMiddle()

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

Shows the middle point for this CircularWedgeKit.

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

◆ ShowPriority()

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

Shows the start point for this CircularWedgeKit.

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

◆ ShowUserData() [1/2]

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

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

◆ ShowUserDataIndices()

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

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetEnd()

HPS.CircularWedgeKit HPS.CircularWedgeKit.UnsetEnd ( )
inline

Removes the end point for this CircularWedgeKit.

Returns
A reference to this CircularWedgeKit.

◆ UnsetEverything()

HPS.CircularWedgeKit HPS.CircularWedgeKit.UnsetEverything ( )
inline

Removes all settings from the CircularWedgeKit.

Returns
A reference to this CircularWedgeKit.

◆ UnsetMiddle()

HPS.CircularWedgeKit HPS.CircularWedgeKit.UnsetMiddle ( )
inline

Removes the middle point for this CircularWedgeKit.

Returns
A reference to this CircularWedgeKit.

◆ UnsetPriority()

HPS.CircularWedgeKit HPS.CircularWedgeKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetStart()

HPS.CircularWedgeKit HPS.CircularWedgeKit.UnsetStart ( )
inline

Removes the start point for this CircularWedgeKit.

Returns
A reference to this CircularWedgeKit.

◆ UnsetUserData() [1/2]

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