API Search || Global Search

#include <hps.h>

Inheritance diagram for HPS::TrimElement:
HPS::Object

Public Member Functions

bool Equals (TrimElement const &in_that) const
 
HPS::Type ObjectType () const
 
bool operator!= (TrimElement const &in_that) const
 
TrimElementoperator= (TrimElement &&in_that)
 
TrimElementoperator= (TrimElement const &in_that)
 
bool operator== (TrimElement const &in_that) const
 
void Set (TrimElement const &in_that)
 
void SetCurve (LineKit const &in_line)
 
void SetCurve (NURBSCurveKit const &in_curve)
 
bool ShowCurve (Trim::Type &out_type, LineKit &out_line, NURBSCurveKit &out_curve) const
 
 TrimElement ()
 
 TrimElement (TrimElement const &in_that)
 
 TrimElement (LineKit const &in_line)
 
 TrimElement (NURBSCurveKit const &in_curve)
 
 TrimElement (TrimElement &&in_that)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::TrimElement
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The TrimElement class is a user space object. It is used to specify the curves that are used to define a trim region.

Constructor & Destructor Documentation

HPS::TrimElement::TrimElement ( )

The default constructor creates an empty TrimElement object.

HPS::TrimElement::TrimElement ( TrimElement const &  in_that)

The copy constructor creates a new TrimElement object that contains the same settings as the source TrimElement.

Parameters
in_thatThe source TrimElement to copy.
HPS::TrimElement::TrimElement ( LineKit const &  in_line)

This constructor creates a TrimElement with a line.

Parameters
in_lineThe 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.
HPS::TrimElement::TrimElement ( NURBSCurveKit const &  in_curve)

This constructor creates a TrimElement with a NURBS curve.

Parameters
in_curveThe 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.
HPS::TrimElement::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_thatAn rvalue reference to a TrimElement to take the impl from.

Member Function Documentation

bool HPS::TrimElement::Equals ( TrimElement const &  in_that) const

Check if the source TrimElement is equivalent to this TrimElement.

Parameters
in_thatThe source TrimElement to compare to this TrimElement.
Returns
true if the objects are equivalent, false otherwise.
bool HPS::TrimElement::operator!= ( TrimElement const &  in_that) const

Check if the source TrimElement is not equivalent to this TrimElement.

Parameters
in_thatThe source TrimElement to compare to this TrimElement.
Returns
true if the objects are not equivalent, false otherwise.
TrimElement& HPS::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_thatAn rvalue reference to a TrimElement to take the impl from.
Returns
A reference to this TrimElement.
TrimElement& HPS::TrimElement::operator= ( TrimElement const &  in_that)

Copies the source TrimElement into this TrimElement.

Parameters
in_thatThe source TrimElement to copy.
Returns
A reference to this TrimElement.
bool HPS::TrimElement::operator== ( TrimElement const &  in_that) const

Check if the source TrimElement is equivalent to this TrimElement.

Parameters
in_thatThe source TrimElement to compare to this TrimElement.
Returns
true if the objects are equivalent, false otherwise.
void HPS::TrimElement::Set ( TrimElement const &  in_that)

Copies the source TrimElement into this TrimElement.

Parameters
in_thatThe source TrimElement to copy.
void HPS::TrimElement::SetCurve ( LineKit const &  in_line)

Sets a line as the curve for this TrimElement.

Parameters
in_lineThe 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 HPS::TrimElement::SetCurve ( NURBSCurveKit const &  in_curve)

Sets a NURBS curve as the curve for this TrimElement.

Parameters
in_curveThe 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 HPS::TrimElement::ShowCurve ( Trim::Type out_type,
LineKit out_line,
NURBSCurveKit out_curve 
) const

Shows the curve for this TrimElement.

Parameters
out_typeThe type of curve used for this TrimElement.
out_lineThe line for the trim curve. This is only valid if out_type</type> is NURBSSurface::Line.
out_curveThe 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.

The documentation for this class was generated from the following file: