HPS::TrimElement Class Reference

The TrimElement class is a user space object. More...

#include <hps.h>

Inheritance diagram for HPS::TrimElement:

Collaboration diagram for HPS::TrimElement:

Public Member Functions
	TrimElement ()
	The default constructor creates an empty TrimElement object. More...
	TrimElement (TrimElement const &in_that)
	The copy constructor creates a new TrimElement object that contains the same settings as the source TrimElement. More...
	TrimElement (LineKit const &in_line)
	This constructor creates a TrimElement with a line. More...
	TrimElement (NURBSCurveKit const &in_curve)
	This constructor creates a TrimElement with a NURBS curve. More...
	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. More...
TrimElement &	operator= (TrimElement &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this TrimElement thereby avoiding a copy. More...
	~TrimElement ()
HPS::Type	ObjectType () const
void	Set (TrimElement const &in_that)
	Copies the source TrimElement into this TrimElement. More...
TrimElement &	operator= (TrimElement const &in_that)
	Copies the source TrimElement into this TrimElement. More...
bool	Equals (TrimElement const &in_that) const
	Check if the source TrimElement is equivalent to this TrimElement. More...
bool	operator== (TrimElement const &in_that) const
	Check if the source TrimElement is equivalent to this TrimElement. More...
bool	operator!= (TrimElement const &in_that) const
	Check if the source TrimElement is not equivalent to this TrimElement. More...
void	SetCurve (LineKit const &in_line)
	Sets a line as the curve for this TrimElement. More...
void	SetCurve (NURBSCurveKit const &in_curve)
	Sets a NURBS curve as the curve for this TrimElement. More...
bool	ShowCurve (Trim::Type &out_type, LineKit &out_line, NURBSCurveKit &out_curve) const
	Shows the curve for this TrimElement. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
virtual bool	Empty () const
	Indicates whether this object has any values set on it. More...
virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...
bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...
intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...
intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::TrimElement

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

TrimElement() [1/5]

HPS::TrimElement::TrimElement

(

)

The default constructor creates an empty TrimElement object.

TrimElement() [2/5]

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_that

The source TrimElement to copy.

TrimElement() [3/5]

HPS::TrimElement::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() [4/5]

HPS::TrimElement::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() [5/5]

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_that

An rvalue reference to a TrimElement to take the impl from.

~TrimElement()

HPS::TrimElement::~TrimElement

(

)

Member Function Documentation

ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

Empty()

virtual bool HPS::Object::Empty ( ) const

inlinevirtualinherited

Indicates whether this object has any values set on it.

Returns

true if no values are set on this object, false otherwise.

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

Equals()

bool HPS::TrimElement::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.

GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns

A unique value shared by all objects of the same class.

GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns

A value unique to an instance of an object and all objects that are backed by the same database resource.

HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask

The Type mask to check against this Object.

Returns

true if this Object has the given Type mask, false otherwise.

ObjectType()

HPS::Type HPS::TrimElement::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Object.

Here is the call graph for this function:

operator!=()

bool HPS::TrimElement::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.

operator=() [1/2]

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_that

An rvalue reference to a TrimElement to take the impl from.

Returns

A reference to this TrimElement.

operator=() [2/2]

TrimElement& HPS::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.

operator==()

bool HPS::TrimElement::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.

Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

Set()

void HPS::TrimElement::Set

(

TrimElement const &

in_that

)

Copies the source TrimElement into this TrimElement.

Parameters

in_that

The source TrimElement to copy.

SetCurve() [1/2]

void HPS::TrimElement::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.

SetCurve() [2/2]

void HPS::TrimElement::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.

ShowCurve()

bool HPS::TrimElement::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.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns

The true type of the object in question.

Reimplemented in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

Member Data Documentation

staticType

const HPS::Type HPS::TrimElement::staticType = HPS::Type::TrimElement

static

---

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

• hps.h