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

Public Member Functions

 CircleKit ()
 
 CircleKit (HPS.CircleKit in_kit)
 
void Consume (HPS.CircleKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.CircleKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.CircleKit in_kit)
 
HPS.CircleKit SetCenter (HPS.Point in_center)
 
HPS.CircleKit SetNormal (HPS.Vector in_normal)
 
HPS.CircleKit SetPriority (int in_priority)
 
HPS.CircleKit SetRadius (float in_radius)
 
HPS.CircleKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.CircleKit SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.CircleKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
void Show (out HPS.CircleKit out_kit)
 
bool ShowCenter (out HPS.Point out_center)
 
bool ShowNormal (out HPS.Vector out_normal)
 
bool ShowPriority (out int out_priority)
 
bool ShowRadius (out float out_radius)
 
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.CircleKit UnsetAllUserData ()
 
HPS.CircleKit UnsetCenter ()
 
HPS.CircleKit UnsetEverything ()
 
HPS.CircleKit UnsetNormal ()
 
HPS.CircleKit UnsetPriority ()
 
HPS.CircleKit UnsetRadius ()
 
HPS.CircleKit UnsetUserData (IntPtr in_index)
 
HPS.CircleKit 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.CircleKit a, HPS.CircleKit b)
 
static bool operator== (HPS.CircleKit a, HPS.CircleKit 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 HPS.CircleKit class is a user space object. It is a kit analog to a HPS.CircleKey.

Constructor & Destructor Documentation

◆ CircleKit() [1/2]

HPS.CircleKit.CircleKit ( )
inline

The default constructor creates an empty CircleKit object.

◆ CircleKit() [2/2]

HPS.CircleKit.CircleKit ( HPS.CircleKit  in_kit)
inline

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

Parameters
in_kitThe source CircleKit to copy.

Member Function Documentation

◆ Consume()

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

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

Parameters
in_kitThe source CircleKit to consume.

◆ Empty()

override bool HPS.CircleKit.Empty ( )
inlinevirtual

Indicates whether this CircleKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source CircleKit is equivalent to this CircleKit.

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

◆ ObjectType()

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

Copies the source CircleKit into this CircleKit.

Parameters
in_kitThe source CircleKit to copy.

◆ SetCenter()

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

Sets the center point for this CircleKit.

Parameters
in_centerThe center point for this CircleKit.
Returns
A reference to this CircleKit.

◆ SetNormal()

HPS.CircleKit HPS.CircleKit.SetNormal ( HPS.Vector  in_normal)
inline

Sets the normal for this CircleKit. This is the normal for the plane in which the circle lies.

Parameters
in_normalThe normal for this CircleKit.
Returns
A reference to this CircleKit.

◆ SetPriority()

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

Assigns a specific drawing priority value to the CircleKit. 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()

◆ SetRadius()

HPS.CircleKit HPS.CircleKit.SetRadius ( float  in_radius)
inline

Sets the radius for this CircleKit.

Parameters
in_radiusThe radius for this CircleKit.
Returns
A reference to this CircleKit.

◆ SetUserData() [1/3]

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

Copies this CircleKit into the given CircleKit.

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

◆ ShowCenter()

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

Shows the center point for this CircleKit.

Parameters
out_centerThe center point for this CircleKit.
Returns
true if a center point was set, false otherwise.

◆ ShowNormal()

bool HPS.CircleKit.ShowNormal ( out HPS.Vector  out_normal)
inline

Shows the normal for this CircleKit.

Parameters
out_normalThe normal for this CircleKit.
Returns
true if a normal was set, false otherwise.

◆ ShowPriority()

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

◆ ShowRadius()

bool HPS.CircleKit.ShowRadius ( out float  out_radius)
inline

Shows the radius for this CircleKit.

Parameters
out_radiusThe radius for this CircleKit.
Returns
true if a radius was set, false otherwise.

◆ ShowUserData() [1/2]

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

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

◆ ShowUserDataIndices()

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

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetCenter()

HPS.CircleKit HPS.CircleKit.UnsetCenter ( )
inline

Removes the center point for this CircleKit.

Returns
A reference to this CircleKit.

◆ UnsetEverything()

HPS.CircleKit HPS.CircleKit.UnsetEverything ( )
inline

Removes all settings from the CircleKit.

Returns
A reference to this CircleKit.

◆ UnsetNormal()

HPS.CircleKit HPS.CircleKit.UnsetNormal ( )
inline

Removes the normal for this CircleKit.

Returns
A reference to this CircleKit.

◆ UnsetPriority()

HPS.CircleKit HPS.CircleKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetRadius()

HPS.CircleKit HPS.CircleKit.UnsetRadius ( )
inline

Removes the radius for this CircleKit.

Returns
A reference to this CircleKit.

◆ UnsetUserData() [1/2]

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