|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static bool | operator!= (HPS.Key a, HPS.Key b) |
|
static bool | operator== (HPS.Key a, HPS.Key b) |
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The SphereKey class is a smart pointer to a database object. It is a handle to a sphere inserted via SegmentKey.InsertSphere.
◆ 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]
The copy constructor creates a SphereKey object that shares the underlying smart-pointer of the source SphereKey.
- Parameters
-
◆ Consume()
Completely replaces all settings on this SphereKey with those set on the specified kit and resets the kit.
- Parameters
-
in_kit | The 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()
Replace those settings on this SphereKey with those set on the specified kit.
- Parameters
-
in_kit | The kit from which to get the settings to replace on this SphereKey. |
◆ SetBasis()
Sets the basis for the SphereKey.
- Parameters
-
in_vertical | The vector to use as the vertical axis for the SphereKey. |
in_horizontal | The vector to use as the horizontal axis for the SphereKey. |
- Returns
- A reference to this SphereKey.
◆ SetCenter()
◆ SetRadius()
◆ Show()
Copy the contents of this SphereKey into the specified kit.
- Parameters
-
out_kit | The kit to populate with the contents of this SphereKey. |
◆ ShowBasis()
Shows the basis for the SphereKey.
- Parameters
-
out_vertical | The vector to use as the vertical axis for the SphereKey. |
out_horizontal | The 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_center | The 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
-
- 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