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

#include <hps.h>

Inheritance diagram for HPS::TrimKit:

Collaboration diagram for HPS::TrimKit:

Public Member Functions
	TrimKit ()
	The default constructor creates an empty TrimKit object. More...

	TrimKit (TrimKit const &in_kit)
	The copy constructor creates a new TrimKit object that contains the same settings as the source TrimKit. More...

	TrimKit (TrimKit &&in_that)
	The move constructor creates a TrimKit by transferring the underlying impl of the rvalue reference to this TrimKit thereby avoiding a copy and allocation. More...

TrimKit &	operator= (TrimKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this TrimKit thereby avoiding a copy. More...

virtual	~TrimKit ()

HPS::Type	ObjectType () const

void	Set (TrimKit const &in_kit)
	Copies the source TrimKit into this TrimKit. More...

void	Show (TrimKit &out_kit) const
	Copies this TrimKit into the given TrimKit. More...

TrimKit &	operator= (TrimKit const &in_kit)
	Copies the source TrimKit into this TrimKit. More...

bool	Empty () const
	Indicates whether this TrimKit has any values set on it. More...

bool	Equals (TrimKit const &in_kit) const
	Check if the source TrimKit is equivalent to this TrimKit. More...

bool	operator== (TrimKit const &in_kit) const
	Check if the source TrimKit is equivalent to this TrimKit. More...

bool	operator!= (TrimKit const &in_kit) const
	Check if the source TrimKit is not equivalent to this TrimKit. More...

TrimKit &	SetShape (size_t in_count, TrimElement const in_shape[])
	Sets the shape of the trim region. More...

TrimKit &	SetShape (TrimElementArray const &in_shape)
	Sets the shape of the trim region. More...

TrimKit &	SetShape (TrimElement const &in_shape)
	Sets the shape of the trim region. More...

TrimKit &	SetOperation (Trim::Operation in_operation)
	Sets the operation for the trim. More...

TrimKit &	UnsetShape ()
	Removes the trim elements defining a trim region. More...

TrimKit &	UnsetOperation ()
	Removes the operation for the trim. More...

TrimKit &	UnsetEverything ()
	Removes all settings from this TrimKit. More...

bool	ShowShape (TrimElementArray &out_shape) const
	Shows the shape of the trim region. More...

bool	ShowOperation (Trim::Operation &out_operation) const
	Shows the operation for the trim. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. 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::TrimKit

Detailed Description

The TrimKit class is a user space object.

It is used to define trim curves (either NURBS curves or lines) that can be used to trim NURBS surfaces.

Constructor & Destructor Documentation

◆ TrimKit() [1/3]

HPS::TrimKit::TrimKit ( )

The default constructor creates an empty TrimKit object.

◆ TrimKit() [2/3]

HPS::TrimKit::TrimKit ( TrimKit const & in_kit )

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

Parameters

in_kit The source TrimKit to copy.

◆ TrimKit() [3/3]

HPS::TrimKit::TrimKit ( TrimKit && in_that )

The move constructor creates a TrimKit by transferring the underlying impl of the rvalue reference to this TrimKit thereby avoiding a copy and allocation.

Parameters

in_that An rvalue reference to a TrimKit to take the impl from.

◆ ~TrimKit()

virtual HPS::TrimKit::~TrimKit ( )

virtual

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()

bool HPS::TrimKit::Empty ( ) const

virtual

Indicates whether this TrimKit has any values set on it.

Returns: true if no values are set on this TrimKit, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::TrimKit::Equals ( TrimKit const & in_kit ) const

Check if the source TrimKit is equivalent to this TrimKit.

Parameters

in_kit The source TrimKit to compare to this TrimKit.

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::TrimKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::TrimKit::operator!= ( TrimKit const & in_kit ) const

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

Parameters

in_kit The source TrimKit to compare to this TrimKit.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

TrimKit& HPS::TrimKit::operator= ( TrimKit && in_that )

The move assignment operator transfers the underlying impl of the rvalue reference to this TrimKit thereby avoiding a copy.

Parameters

in_that An rvalue reference to a TrimKit to take the impl from.

Returns: A reference to this TrimKit.

◆ operator=() [2/2]

TrimKit& HPS::TrimKit::operator= ( TrimKit const & in_kit )

Copies the source TrimKit into this TrimKit.

Parameters

in_kit The source TrimKit to copy.

Returns: A reference to this TrimKit.

◆ operator==()

bool HPS::TrimKit::operator== ( TrimKit const & in_kit ) const

Check if the source TrimKit is equivalent to this TrimKit.

Parameters

in_kit The source TrimKit to compare to this TrimKit.

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::TrimKit::Set ( TrimKit const & in_kit )

Copies the source TrimKit into this TrimKit.

Parameters

in_kit The source TrimKit to copy.

◆ SetOperation()

TrimKit& HPS::TrimKit::SetOperation ( Trim::Operation in_operation )

Sets the operation for the trim.

Parameters

in_operation The operation for the trim.

Returns: A reference to this TrimKit.

◆ SetShape() [1/3]

TrimKit& HPS::TrimKit::SetShape	(	size_t	in_count,
		TrimElement const	in_shape[]
	)

Sets the shape of the trim region.

The shape is a collection of trim elements.

Parameters

in_count	Size of the following array.
in_shape	An array of trim elements defining a trim region.

Returns: A reference to this TrimKit.

◆ SetShape() [2/3]

TrimKit& HPS::TrimKit::SetShape ( TrimElementArray const & in_shape )

Sets the shape of the trim region.

The shape is a collection of trim elements.

Parameters

in_shape An array of trim elements defining a trim region.

Returns: A reference to this TrimKit.

◆ SetShape() [3/3]

TrimKit& HPS::TrimKit::SetShape ( TrimElement const & in_shape )

Sets the shape of the trim region.

Parameters

in_shape An trim element defining a trim region.

Returns: A reference to this TrimKit.

◆ Show()

void HPS::TrimKit::Show ( TrimKit & out_kit ) const

Copies this TrimKit into the given TrimKit.

Parameters

out_kit The TrimKit to populate with the contents of this TrimKit.

◆ ShowOperation()

bool HPS::TrimKit::ShowOperation ( Trim::Operation & out_operation ) const

Shows the operation for the trim.

Parameters

out_operation The operation for the trim.

Returns: true if an operation was set, false otherwise.

◆ ShowShape()

bool HPS::TrimKit::ShowShape ( TrimElementArray & out_shape ) const

Shows the shape of the trim region.

Parameters

out_shape The array of trim elements defining a trim region.

Returns: true if a shape was set, false otherwise.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

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 from HPS::Object.

◆ UnsetEverything()

TrimKit& HPS::TrimKit::UnsetEverything ( )

Removes all settings from this TrimKit.

Returns: A reference to this TrimKit.

◆ UnsetOperation()

TrimKit& HPS::TrimKit::UnsetOperation ( )

Removes the operation for the trim.

Returns: A reference to this TrimKit.

◆ UnsetShape()

TrimKit& HPS::TrimKit::UnsetShape ( )

Removes the trim elements defining a trim region.

Returns: A reference to this TrimKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::TrimKit::staticType = HPS::Type::TrimKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TrimKit() [1/3]

◆ TrimKit() [2/3]

◆ TrimKit() [3/3]

◆ ~TrimKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetOperation()

◆ SetShape() [1/3]

◆ SetShape() [2/3]

◆ SetShape() [3/3]

◆ Show()

◆ ShowOperation()

◆ ShowShape()

◆ Type()

◆ UnsetEverything()

◆ UnsetOperation()

◆ UnsetShape()

Member Data Documentation

◆ staticType