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

Public Member Functions

void Consume (HPS.SphereKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.SphereKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.SphereKit in_kit)
 
HPS.SphereKit SetBasis (HPS.Vector in_vertical, HPS.Vector in_horizontal)
 
HPS.SphereKit SetCenter (HPS.Point in_center)
 
HPS.SphereKit SetPriority (int in_priority)
 
HPS.SphereKit SetRadius (float in_radius)
 
HPS.SphereKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.SphereKit SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.SphereKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
void Show (out HPS.SphereKit out_kit)
 
bool ShowBasis (out HPS.Vector out_vertical, out HPS.Vector out_horizontal)
 
bool ShowCenter (out HPS.Point out_center)
 
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)
 
 SphereKit ()
 
 SphereKit (HPS.SphereKit in_kit)
 
HPS.SphereKit UnsetAllUserData ()
 
HPS.SphereKit UnsetBasis ()
 
HPS.SphereKit UnsetCenter ()
 
HPS.SphereKit UnsetEverything ()
 
HPS.SphereKit UnsetPriority ()
 
HPS.SphereKit UnsetRadius ()
 
HPS.SphereKit UnsetUserData (IntPtr in_index)
 
HPS.SphereKit UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
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.SphereKit a, HPS.SphereKit b)
 
static bool operator== (HPS.SphereKit a, HPS.SphereKit 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.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The SphereKit class is a user space object. It is a kit analog to a SphereKey.

Constructor & Destructor Documentation

◆ SphereKit() [1/2]

HPS.SphereKit.SphereKit ( )
inline

The default constructor creates an empty SphereKit object.

◆ SphereKit() [2/2]

HPS.SphereKit.SphereKit ( HPS.SphereKit  in_kit)
inline

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

Parameters
in_kitThe source SphereKit to copy.

Member Function Documentation

◆ Consume()

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

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

Parameters
in_kitThe source SphereKit to consume.

◆ Empty()

override bool HPS.SphereKit.Empty ( )
inlinevirtual

Indicates whether this SphereKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source SphereKit is equivalent to this SphereKit.

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

◆ ObjectType()

override HPS.Type HPS.SphereKit.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.Kit.

◆ Set()

void HPS.SphereKit.Set ( HPS.SphereKit  in_kit)
inline

Copies the source SphereKit into this SphereKit.

Parameters
in_kitThe source SphereKit to copy.

◆ SetBasis()

HPS.SphereKit HPS.SphereKit.SetBasis ( HPS.Vector  in_vertical,
HPS.Vector  in_horizontal 
)
inline

Sets the basis for the SphereKit.

Parameters
in_verticalThe vector to use as the vertical axis for the SphereKit.
in_horizontalThe vector to use as the horizontal axis for the SphereKit.
Returns
A reference to this SphereKit.

◆ SetCenter()

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

Sets the center point for the SphereKit.

Parameters
in_centerThe center point for the SphereKit.
Returns
A reference to this SphereKit.

◆ SetPriority()

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

Assigns a specific drawing priority value to the SphereKit. 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.SphereKit HPS.SphereKit.SetRadius ( float  in_radius)
inline

Sets the radius for the SphereKit.

Parameters
in_radiusThe radius for the SphereKit.
Returns
A reference to this SphereKit.

◆ SetUserData() [1/3]

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

Copies this SphereKit into the given SphereKit.

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

◆ ShowBasis()

bool HPS.SphereKit.ShowBasis ( out HPS.Vector  out_vertical,
out HPS.Vector  out_horizontal 
)
inline

Shows the basis for the SphereKit.

Parameters
out_verticalThe vector to use as the vertical axis for the SphereKit.
out_horizontalThe vector to use as the horizontal axis for the SphereKit.
Returns
true if a basis was set, false otherwise.

◆ ShowCenter()

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

Shows the center point for this SphereKit.

Parameters
out_centerThe center point for the SphereKit.
Returns
true if a center point was set, false otherwise.

◆ ShowPriority()

bool HPS.SphereKit.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.SphereKit.ShowRadius ( out float  out_radius)
inline

Shows the radius for the SphereKit.

Parameters
out_radiusThe radius for the SphereKit.
Returns
true if a radius was set, false otherwise.

◆ ShowUserData() [1/2]

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

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

◆ ShowUserDataIndices()

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

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetBasis()

HPS.SphereKit HPS.SphereKit.UnsetBasis ( )
inline

Removes the basis for this SphereKit.

Returns
A reference to this SphereKit.

◆ UnsetCenter()

HPS.SphereKit HPS.SphereKit.UnsetCenter ( )
inline

Removes the center point for this SphereKit.

Returns
A reference to this SphereKit.

◆ UnsetEverything()

HPS.SphereKit HPS.SphereKit.UnsetEverything ( )
inline

Removes all settings from the SphereKit.

Returns
A reference to this SphereKit.

◆ UnsetPriority()

HPS.SphereKit HPS.SphereKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetRadius()

HPS.SphereKit HPS.SphereKit.UnsetRadius ( )
inline

Removes the radius for this SphereKit.

Returns
A reference to this SphereKit.

◆ UnsetUserData() [1/2]

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