API Search || Global Search

More...

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

Public Member Functions

 CircleKit ()
 The default constructor creates an empty CircleKit object. More...
 
 CircleKit (HPS.CircleKit in_kit)
 The copy constructor creates a new CircleKit object that contains the same settings as the source CircleKit. More...
 
void Consume (HPS.CircleKit in_kit)
 Copies the source CircleKit into this CircleKit and resets the source kit. More...
 
override void Dispose ()
 
override bool Empty ()
 Indicates whether this CircleKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.CircleKit in_kit)
 Check if the source CircleKit is equivalent to this CircleKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.CircleKit in_kit)
 Copies the source CircleKit into this CircleKit. More...
 
HPS.CircleKit SetCenter (HPS.Point in_center)
 Sets the center point for this CircleKit. More...
 
HPS.CircleKit SetNormal (HPS.Vector in_normal)
 Sets the normal for this CircleKit. This is the normal for the plane in which the circle lies. More...
 
HPS.CircleKit SetPriority (int in_priority)
 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. More...
 
HPS.CircleKit SetRadius (float in_radius)
 Sets the radius for this CircleKit. More...
 
HPS.CircleKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 Sets user data on this kit. More...
 
HPS.CircleKit SetUserData (IntPtr in_index, byte[] in_data)
 Sets user data on this kit. More...
 
HPS.CircleKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 Sets user data on this kit. More...
 
void Show (out HPS.CircleKit out_kit)
 Copies this CircleKit into the given CircleKit. More...
 
bool ShowCenter (out HPS.Point out_center)
 Shows the center point for this CircleKit. More...
 
bool ShowNormal (out HPS.Vector out_normal)
 Shows the normal for this CircleKit. More...
 
bool ShowPriority (out int out_priority)
 Shows the drawing priority. More...
 
bool ShowRadius (out float out_radius)
 Shows the radius for this CircleKit. More...
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 Shows the user data at a given index for this kit. More...
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 Shows all user data for this kit. More...
 
ulong ShowUserDataCount ()
 Get the number of user data indices set on this kit. More...
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 Shows the indices of all user data set on this kit. More...
 
HPS.CircleKit UnsetAllUserData ()
 Removes all user data from this kit. More...
 
HPS.CircleKit UnsetCenter ()
 Removes the center point for this CircleKit. More...
 
HPS.CircleKit UnsetEverything ()
 Removes all settings from the CircleKit. More...
 
HPS.CircleKit UnsetNormal ()
 Removes the normal for this CircleKit. More...
 
HPS.CircleKit UnsetPriority ()
 Removes a drawing priority setting. More...
 
HPS.CircleKit UnsetRadius ()
 Removes the radius for this CircleKit. More...
 
HPS.CircleKit UnsetUserData (IntPtr in_index)
 Removes the user data at the given index from this kit. More...
 
HPS.CircleKit UnsetUserData (IntPtr[] in_indices)
 Removes the user data at the given indices from this kit. More...
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 

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

HPS.CircleKit.CircleKit ( )
inline

The default constructor creates an empty CircleKit object.

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

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.
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.

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

Copies the source CircleKit into this CircleKit.

Parameters
in_kitThe source CircleKit to copy.
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.
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.
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.

SubwindowKit.SetPriority()

SubwindowKit.SetRenderingAlgorithm()

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

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

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

Removes all user data from this kit.

Returns
    A reference to this kit.
HPS.CircleKit HPS.CircleKit.UnsetCenter ( )
inline

Removes the center point for this CircleKit.

Returns
    A reference to this CircleKit.
HPS.CircleKit HPS.CircleKit.UnsetEverything ( )
inline

Removes all settings from the CircleKit.

Returns
    A reference to this CircleKit.
HPS.CircleKit HPS.CircleKit.UnsetNormal ( )
inline

Removes the normal for this CircleKit.

Returns
    A reference to this CircleKit.
HPS.CircleKit HPS.CircleKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
    A reference to this object.
HPS.CircleKit HPS.CircleKit.UnsetRadius ( )
inline

Removes the radius for this CircleKit.

Returns
    A reference to this CircleKit.
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.
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