TrimElement
-
class HPS::TrimElement : public HPS::Object
The TrimElement class is a user space object. It is used to specify the curves that are used to define a trim region.
Public Functions
-
bool Equals(TrimElement const &in_that) const
Check if the source TrimElement is equivalent to this TrimElement.
- Parameters
in_that – The source TrimElement to compare to this TrimElement.
- Returns
true if the objects are equivalent, false otherwise.
-
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.
-
bool operator!=(TrimElement const &in_that) const
Check if the source TrimElement is not equivalent to this TrimElement.
- Parameters
in_that – The source TrimElement to compare to this TrimElement.
- Returns
true if the objects are not equivalent, false otherwise.
-
TrimElement &operator=(TrimElement &&in_that)
The move assignment operator transfers the underlying impl of the rvalue reference to this TrimElement thereby avoiding a copy.
- Parameters
in_that – An rvalue reference to a TrimElement to take the impl from.
- Returns
A reference to this TrimElement.
-
TrimElement &operator=(TrimElement const &in_that)
Copies the source TrimElement into this TrimElement.
- Parameters
in_that – The source TrimElement to copy.
- Returns
A reference to this TrimElement.
-
bool operator==(TrimElement const &in_that) const
Check if the source TrimElement is equivalent to this TrimElement.
- Parameters
in_that – The source TrimElement to compare to this TrimElement.
- Returns
true if the objects are equivalent, false otherwise.
-
void Set(TrimElement const &in_that)
Copies the source TrimElement into this TrimElement.
- Parameters
in_that – The source TrimElement to copy.
-
void SetCurve(LineKit const &in_line)
Sets a line as the curve for this TrimElement.
- Parameters
in_line – The line for this TrimElement. Only the X and Y coordinates of the points defining the line will be used when the trim region is applied to a surface. The coordinates will be treated as U and V parameter values in the normalized parameter space for the NURBS surface.
-
void SetCurve(NURBSCurveKit const &in_curve)
Sets a NURBS curve as the curve for this TrimElement.
- Parameters
in_curve – The NURBS curve for this TrimElement. Only the X and Y coordinates of the control points defining the curve will be used when the trim region is applied to a surface. The coordinates will be treated as U and V parameter values in the normalized parameter space for the NURBS surface.
-
bool ShowCurve(Trim::Type &out_type, LineKit &out_line, NURBSCurveKit &out_curve) const
Shows the curve for this TrimElement.
- Parameters
out_type – The type of curve used for this TrimElement.
out_line – The line for the trim curve. This is only valid if out_type</type> is NURBSSurface::Line.
out_curve – The NURBS curve for the trim curve. This is only valid if out_type</type> is NURBSSurface::Curve.
- Returns
true if a line or NURBS curve was set, false otherwise.
-
TrimElement()
The default constructor creates an empty TrimElement object.
-
TrimElement(LineKit const &in_line)
This constructor creates a TrimElement with a line.
- Parameters
in_line – The line for this TrimElement. Only the X and Y coordinates of the points defining the line will be used when the trim region is applied to a surface. The coordinates will be treated as U and V parameter values in the normalized parameter space for the NURBS surface.
-
TrimElement(NURBSCurveKit const &in_curve)
This constructor creates a TrimElement with a NURBS curve.
- Parameters
in_curve – The NURBS curve for this TrimElement. Only the X and Y coordinates of the control points defining the curve will be used when the trim region is applied to a surface. The coordinates will be treated as U and V parameter values in the normalized parameter space for the NURBS surface.
-
TrimElement(TrimElement &&in_that)
The move constructor creates a TrimElement by transferring the underlying impl of the rvalue reference to this TrimElement thereby avoiding a copy and allocation.
- Parameters
in_that – An rvalue reference to a TrimElement to take the impl from.
-
TrimElement(TrimElement const &in_that)
The copy constructor creates a new TrimElement object that contains the same settings as the source TrimElement.
- Parameters
in_that – The source TrimElement to copy.
-
~TrimElement()
Public Static Attributes
-
static const HPS::Type staticType = HPS::Type::TrimElement
-
bool Equals(TrimElement const &in_that) const
