CircularWedgeKey
-
class HPS::CircularWedgeKey : public HPS::GeometryKey
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.
Public Functions
-
CircularWedgeKey()
The default constructor creates an uninitialized CircularWedgeKey object. The Type() function will return Type::None.
-
CircularWedgeKey(CircularWedgeKey &&in_that)
The move constructor creates a CircularWedgeKey by transferring the underlying impl of the rvalue reference to this CircularWedgeKey thereby avoiding a copy and allocation.
- Parameters
in_that – An rvalue reference to a CircularWedgeKey to take the impl from.
-
CircularWedgeKey(CircularWedgeKey const &in_that)
The copy constructor creates a CircularWedgeKey object that shares the underlying smart-pointer of the source CircularWedgeKey.
- Parameters
in_that – The source CircularWedgeKey to copy.
-
explicit CircularWedgeKey(Key const &in_that)
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.
- Parameters
in_key – The source Key to copy.
-
void Consume(CircularWedgeKit &in_kit)
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.
-
inline virtual HPS::Type ObjectType() const
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.
-
CircularWedgeKey &operator=(CircularWedgeKey &&in_that)
The move assignment operator transfers the underlying impl of the rvalue reference to this CircularWedgeKey thereby avoiding a copy.
- Parameters
in_that – An rvalue reference to a CircularWedgeKey to take the impl from.
- Returns
A reference to this CircularWedgeKey.
-
CircularWedgeKey &operator=(CircularWedgeKey const &in_that)
Associate this CircularWedgeKey with the same underlying impl as the source CircularWedgeKey.
- Parameters
in_that – The source CircularWedgeKey for the assignment.
- Returns
A reference to this CircularWedgeKey.
-
void Set(CircularWedgeKit const &in_kit)
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.
-
CircularWedgeKey &SetEnd(Point const &in_end)
Sets the end point for this CircularWedgeKey. This is the point on the circumference of the circle at which the circular wedge ends.
- Parameters
in_end – The end point for this CircularWedgeKey.
- Returns
A reference to this CircularWedgeKey.
-
CircularWedgeKey &SetMiddle(Point const &in_middle)
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
in_middle – The middle point for this CircularWedgeKey.
- Returns
A reference to this CircularWedgeKey.
-
CircularWedgeKey &SetStart(Point const &in_start)
Sets the start point for this CircularWedgeKey. This is the point on the circumference of the circle at which the circular wedge starts.
- Parameters
in_start – The start point for this CircularWedgeKey.
- Returns
A reference to this CircularWedgeKey.
-
void Show(CircularWedgeKit &out_kit) const
Copy the contents of this CircularWedgeKey into the specified kit.
- Parameters
out_kit – The kit to populate with the contents of this CircularWedgeKey.
-
bool ShowEnd(Point &out_end) const
Shows the end point for this CircularWedgeKey.
- Parameters
out_end – The end point for this CircularWedgeKey.
- Returns
true if an end point was set, false otherwise.
-
bool ShowMiddle(Point &out_middle) const
Shows the middle point for this CircularWedgeKey.
- Parameters
out_middle – The middle point for this CircularWedgeKey.
- Returns
true if a middle point was set, false otherwise.
-
bool ShowStart(Point &out_start) const
Shows the start point for this CircularWedgeKey.
- Parameters
out_start – The start point for this CircularWedgeKey.
- Returns
true if a start point was set, false otherwise.
-
~CircularWedgeKey()
Public Static Attributes
-
static const HPS::Type staticType = HPS::Type::CircularWedgeKey
-
CircularWedgeKey()