Inheritance diagram for HPS.SphereKey:
HPS.GeometryKey HPS.Key HPS.Object

Public Member Functions

void Consume (HPS.SphereKit in_kit)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.SphereKit in_kit)
 
HPS.SphereKey SetBasis (HPS.Vector in_vertical, HPS.Vector in_horizontal)
 
HPS.SphereKey SetCenter (HPS.Point in_center)
 
HPS.SphereKey SetRadius (float in_radius)
 
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 ShowRadius (out float out_radius)
 
 SphereKey ()
 
 SphereKey (HPS.Key in_that)
 
 SphereKey (HPS.SphereKey in_that)
 
- Public Member Functions inherited from HPS.GeometryKey
 GeometryKey ()
 
 GeometryKey (HPS.Key in_that)
 
 GeometryKey (HPS.GeometryKey in_that)
 
HPS.GeometryKey SetPriority (int in_priority)
 
HPS.GeometryKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
bool ShowBounding (out HPS.BoundingKit out_kit)
 
bool ShowPriority (out int out_priority)
 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 
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.GeometryKey UnsetAllUserData ()
 
HPS.GeometryKey UnsetPriority ()
 
HPS.GeometryKey UnsetUserData (IntPtr in_index)
 
HPS.GeometryKey UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 
void Delete ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 
ulong GetHash ()
 
override int GetHashCode ()
 
bool HasOwner ()
 
 Key ()
 
 Key (HPS.Key in_that)
 
 Key (HPS.Control in_control)
 
void MoveTo (HPS.SegmentKey in_new_owner)
 
HPS.SegmentKey Owner ()
 
HPS.SegmentKey Up ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator!= (HPS.Key a, HPS.Key b)
 
static bool operator== (HPS.Key a, HPS.Key b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The SphereKey class is a smart pointer to a database object. It is a handle to a sphere inserted via SegmentKey.InsertSphere.

Constructor & Destructor Documentation

◆ SphereKey() [1/3]

HPS.SphereKey.SphereKey ( )
inline

The default constructor creates an uninitialized SphereKey object. The Type() function will return Type.None.

◆ SphereKey() [2/3]

HPS.SphereKey.SphereKey ( HPS.Key  in_that)
inline

This constructor creates a SphereKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a Sphere key. Otherwise the copy will fail and the resulting SphereKey will be invalid.

◆ SphereKey() [3/3]

HPS.SphereKey.SphereKey ( HPS.SphereKey  in_that)
inline

The copy constructor creates a SphereKey object that shares the underlying smart-pointer of the source SphereKey.

Parameters
in_thatThe source SphereKey to copy.

Member Function Documentation

◆ Consume()

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

Completely replaces all settings on this SphereKey with those set on the specified kit and resets the kit.

Parameters
in_kitThe kit from which to get the settings to replace on this SphereKey.

◆ ObjectType()

override HPS.Type HPS.SphereKey.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.GeometryKey.

◆ Set()

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

Replace those settings on this SphereKey with those set on the specified kit.

Parameters
in_kitThe kit from which to get the settings to replace on this SphereKey.

◆ SetBasis()

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

Sets the basis for the SphereKey.

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

◆ SetCenter()

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

Sets the center point for the SphereKey.

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

◆ SetRadius()

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

Sets the radius for the SphereKey.

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

◆ Show()

void HPS.SphereKey.Show ( out HPS.SphereKit  out_kit)
inline

Copy the contents of this SphereKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this SphereKey.

◆ ShowBasis()

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

Shows the basis for the SphereKey.

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

◆ ShowCenter()

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

Shows the center point for this SphereKey.

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

◆ ShowRadius()

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

Shows the radius for the SphereKey.

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

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.SphereKey.cs