|
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 CircularWedgeKey class is a smart pointer to a database object. It is a handle to a circular wedge inserted via SegmentKey.InsertCircularWedge. A circular wedge has face geometry contained within the boundary edges of the circular wedge. The visualization of the wedge will be determined by attribute settings affecting faces and edges.
◆ CircularWedgeKey() [1/3]
HPS.CircularWedgeKey.CircularWedgeKey |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized CircularWedgeKey object. The Type() function will return Type.None.
◆ CircularWedgeKey() [2/3]
HPS.CircularWedgeKey.CircularWedgeKey |
( |
HPS.Key |
in_that | ) |
|
|
inline |
This constructor creates a CircularWedgeKey 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 CircularWedge key. Otherwise the copy will fail and the resulting CircularWedgeKey will be invalid.
◆ CircularWedgeKey() [3/3]
◆ Consume()
Completely replaces all settings on this CircularWedgeKey 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 CircularWedgeKey. |
◆ ObjectType()
override HPS.Type HPS.CircularWedgeKey.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 CircularWedgeKey with those set on the specified kit.
- Parameters
-
in_kit | The kit from which to get the settings to replace on this CircularWedgeKey. |
◆ SetEnd()
Sets the end point for this CircularWedgeKey. This is the point on the circumference of the circle at which the circular wedge ends.
- Parameters
-
- Returns
- A reference to this CircularWedgeKey.
◆ SetMiddle()
Sets the middle point for this CircularWedgeKey. This is a point on the circumference of the circle between the start and end points for the circular wedge.
- Parameters
-
- Returns
- A reference to this CircularWedgeKey.
◆ SetStart()
Sets the start point for this CircularWedgeKey. This is the point on the circumference of the circle at which the circular wedge starts.
- Parameters
-
- Returns
- A reference to this CircularWedgeKey.
◆ Show()
◆ ShowEnd()
bool HPS.CircularWedgeKey.ShowEnd |
( |
out HPS.Point |
out_end | ) |
|
|
inline |
Shows the end point for this CircularWedgeKey.
- Parameters
-
- Returns
- true if an end point was set, false otherwise.
◆ ShowMiddle()
bool HPS.CircularWedgeKey.ShowMiddle |
( |
out HPS.Point |
out_middle | ) |
|
|
inline |
Shows the middle point for this CircularWedgeKey.
- Parameters
-
- Returns
- true if a middle point was set, false otherwise.
◆ ShowStart()
bool HPS.CircularWedgeKey.ShowStart |
( |
out HPS.Point |
out_start | ) |
|
|
inline |
Shows the start point for this CircularWedgeKey.
- Parameters
-
- Returns
- true if a start point was set, false otherwise.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.CircularWedgeKey.cs