|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
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 CircleKey class is a smart pointer to a database object. It is a handle to a circle inserted via SegmentKey.InsertCircle. A circle has face geometry contained within its circumference. The visualization of the circle will be determined by attribute settings affecting faces and edges.
◆ CircleKey() [1/3]
HPS.CircleKey.CircleKey |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized CircleKey object. The Type() function will return Type.None.
◆ CircleKey() [2/3]
HPS.CircleKey.CircleKey |
( |
HPS.Key |
in_that | ) |
|
|
inline |
This constructor creates a CircleKey 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 Circle key. Otherwise the copy will fail and the resulting CircleKey will be invalid.
◆ CircleKey() [3/3]
The copy constructor creates a CircleKey object that shares the underlying smart-pointer of the source CircleKey.
- Parameters
-
◆ Consume()
Completely replaces all settings on this CircleKey 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 CircleKey. |
◆ ObjectType()
override HPS.Type HPS.CircleKey.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()
Replace those settings on this CircleKey with those set on the specified kit.
- Parameters
-
in_kit | The kit from which to get the settings to replace on this CircleKey. |
◆ SetCenter()
Sets the center point for this CircleKey.
- Parameters
-
in_center | The center point for this CircleKey. |
- Returns
- A reference to this CircleKey.
◆ SetNormal()
Sets the normal for this CircleKey. This is the normal for the plane in which the circle lies.
- Parameters
-
- Returns
- A reference to this CircleKey.
◆ SetRadius()
◆ Show()
Copy the contents of this CircleKey into the specified kit.
- Parameters
-
out_kit | The kit to populate with the contents of this CircleKey. |
◆ ShowCenter()
bool HPS.CircleKey.ShowCenter |
( |
out HPS.Point |
out_center | ) |
|
|
inline |
Shows the center point for this CircleKey.
- Parameters
-
out_center | The center point for this CircleKey. |
- Returns
- true if a center point was set, false otherwise.
◆ ShowNormal()
bool HPS.CircleKey.ShowNormal |
( |
out HPS.Vector |
out_normal | ) |
|
|
inline |
Shows the normal for this CircleKey.
- Parameters
-
- Returns
- true if a normal was set, false otherwise.
◆ ShowRadius()
bool HPS.CircleKey.ShowRadius |
( |
out float |
out_radius | ) |
|
|
inline |
Shows the radius for this CircleKey.
- 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.CircleKey.cs