Configuration options kit for controlling HPS::Segment::Optimize behavior. More...

#include <hps.h>

Inheritance diagram for HPS::SegmentOptimizationOptionsKit:

Collaboration diagram for HPS::SegmentOptimizationOptionsKit:

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

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

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

virtual	~SegmentOptimizationOptionsKit ()

HPS::Type	ObjectType () const

void	Consume (SegmentOptimizationOptionsKit &in_kit)
	Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit and resets the source kit. More...

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

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

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

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

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

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

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

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

SegmentOptimizationOptionsKit &	SetUserData (HPS::SegmentOptimizationOptions::UserData in_user_data)
	Controls whether or not user data is discarded, preserved, merged, localized, or left as is. More...

SegmentOptimizationOptionsKit &	SetMatrix (HPS::SegmentOptimizationOptions::Matrix in_matrix)
	Controls whether or not matrices are localized, collapsed, or left as is. More...

SegmentOptimizationOptionsKit &	SetExpansion (HPS::SegmentOptimizationOptions::Expansion in_expansion)
	Controls whether or not includes or references are expanded. More...

SegmentOptimizationOptionsKit &	SetScope (HPS::SegmentOptimizationOptions::Scope in_scope)
	Controls the traversal scope of the optimization operation. More...

SegmentOptimizationOptionsKit &	SetReorganization (HPS::SegmentOptimizationOptions::Reorganization in_reorganization)
	Controls how the tree is reorganized. More...

SegmentOptimizationOptionsKit &	SetShellInstancing (bool in_shell_instancing)
	Controls whether or not duplicate shells are instanced. More...

SegmentOptimizationOptionsKit &	SetShellMerging (bool in_shell_merging)
	Controls whether or not distinct shells are merged into consolidated shells. More...

SegmentOptimizationOptionsKit &	SetAttributeDelocalization (bool in_attribute_delocalization)
	Controls whether or not local attributes will be pulled out of geometry. More...

SegmentOptimizationOptionsKit &	UnsetUserData ()
	Unsets the UserData value on this kit. More...

SegmentOptimizationOptionsKit &	UnsetMatrix ()
	Unsets the Matrix value on this kit. More...

SegmentOptimizationOptionsKit &	UnsetExpansion ()
	Unsets the Expansion value on this kit. More...

SegmentOptimizationOptionsKit &	UnsetScope ()
	Unsets the Scope value on this kit. More...

SegmentOptimizationOptionsKit &	UnsetReorganization ()
	Unsets the Reorganization value on this kit. More...

SegmentOptimizationOptionsKit &	UnsetShellInstancing ()
	Unsets the ShellInstancing value on this kit. More...

SegmentOptimizationOptionsKit &	UnsetShellMerging ()
	Unsets the ShellMerging value on this kit. More...

SegmentOptimizationOptionsKit &	UnsetAttributeDelocalization ()
	Unsets the ttributeDelocalization value on this kit. More...

SegmentOptimizationOptionsKit &	UnsetEverything ()
	Removes all settings from this object. More...

bool	ShowUserData (HPS::SegmentOptimizationOptions::UserData &out_user_data) const
	Shows the User Data setting. More...

bool	ShowMatrix (HPS::SegmentOptimizationOptions::Matrix &out_matrix) const
	Shows the Matrix setting. More...

bool	ShowExpansion (HPS::SegmentOptimizationOptions::Expansion &out_expansion) const
	Shows the Expansion setting. More...

bool	ShowScope (HPS::SegmentOptimizationOptions::Scope &out_scope) const
	Shows the Scope setting. More...

bool	ShowReorganization (HPS::SegmentOptimizationOptions::Reorganization &out_reorganization) const
	Shows the Reorganization setting. More...

bool	ShowShellInstancing (bool &out_shell_instancing) const
	Shows the Shell Instancing setting. More...

bool	ShowShellMerging (bool &out_shell_merging) const
	Shows the Shell Merging setting. More...

bool	ShowAttributeDelocalization (bool &out_attribute_delocalization) const
	Shows the Attribute Delocalization setting. 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::SegmentOptimizationOptionsKit

Detailed Description

Configuration options kit for controlling HPS::Segment::Optimize behavior.

Constructor & Destructor Documentation

◆ SegmentOptimizationOptionsKit() [1/3]

HPS::SegmentOptimizationOptionsKit::SegmentOptimizationOptionsKit ( )

The default constructor creates an empty SegmentOptimizationOptionsKit object.

◆ SegmentOptimizationOptionsKit() [2/3]

HPS::SegmentOptimizationOptionsKit::SegmentOptimizationOptionsKit ( SegmentOptimizationOptionsKit const & in_kit )

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

Parameters

in_kit The source SegmentOptimizationOptionsKit to copy.

◆ SegmentOptimizationOptionsKit() [3/3]

HPS::SegmentOptimizationOptionsKit::SegmentOptimizationOptionsKit ( SegmentOptimizationOptionsKit && in_kit )

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

Parameters

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

◆ ~SegmentOptimizationOptionsKit()

virtual HPS::SegmentOptimizationOptionsKit::~SegmentOptimizationOptionsKit ( )

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.

◆ Consume()

void HPS::SegmentOptimizationOptionsKit::Consume ( SegmentOptimizationOptionsKit & in_kit )

Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit and resets the source kit.

Parameters

in_kit The source SegmentOptimizationOptionsKit to consume.

◆ Empty()

bool HPS::SegmentOptimizationOptionsKit::Empty ( ) const

virtual

Indicates whether this SegmentOptimizationOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source SegmentOptimizationOptionsKit is equivalent to this SegmentOptimizationOptionsKit.

Parameters

in_kit The source SegmentOptimizationOptionsKit to compare to this SegmentOptimizationOptionsKit.

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

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source SegmentOptimizationOptionsKit to compare to this SegmentOptimizationOptionsKit.

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

◆ operator=() [1/2]

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

Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit.

Parameters

in_kit The source SegmentOptimizationOptionsKit to copy.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ operator=() [2/2]

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::operator= ( SegmentOptimizationOptionsKit && in_kit )

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

Parameters

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

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ operator==()

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

Check if the source SegmentOptimizationOptionsKit is equivalent to this SegmentOptimizationOptionsKit.

Parameters

in_kit The source SegmentOptimizationOptionsKit to compare to this SegmentOptimizationOptionsKit.

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

Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit.

Parameters

in_kit The source SegmentOptimizationOptionsKit to copy.

◆ SetAttributeDelocalization()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetAttributeDelocalization ( bool in_attribute_delocalization )

Controls whether or not local attributes will be pulled out of geometry.

Parameters

in_attribute_delocalization Denotes whether or not local attributes will be pulled out of geometry.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ SetExpansion()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetExpansion ( HPS::SegmentOptimizationOptions::Expansion in_expansion )

Controls whether or not includes or references are expanded.

Parameters

in_expansion The enum value describing how to handle includes and references.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ SetMatrix()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetMatrix ( HPS::SegmentOptimizationOptions::Matrix in_matrix )

Controls whether or not matrices are localized, collapsed, or left as is.

Parameters

in_matrix The enum value describing how to handle matrices.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ SetReorganization()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetReorganization ( HPS::SegmentOptimizationOptions::Reorganization in_reorganization )

Controls how the tree is reorganized.

Parameters

in_reorganization The enum value describing how to reorganize the tree.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ SetScope()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetScope ( HPS::SegmentOptimizationOptions::Scope in_scope )

Controls the traversal scope of the optimization operation.

Parameters

in_scope The enum value describing the traversal scope of the optimization.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ SetShellInstancing()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetShellInstancing ( bool in_shell_instancing )

Controls whether or not duplicate shells are instanced.

Parameters

in_shell_instancing Denotes whether or not shells will be instanced.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ SetShellMerging()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetShellMerging ( bool in_shell_merging )

Controls whether or not distinct shells are merged into consolidated shells.

Parameters

in_shell_merging Denotes whether or not shells will be merged.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ SetUserData()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::SetUserData ( HPS::SegmentOptimizationOptions::UserData in_user_data )

Controls whether or not user data is discarded, preserved, merged, localized, or left as is.

Parameters

in_user_data The enum value describing how to handle user data.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ Show()

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

Copies this SegmentOptimizationOptionsKit into the given SegmentOptimizationOptionsKit.

Parameters

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

◆ ShowAttributeDelocalization()

bool HPS::SegmentOptimizationOptionsKit::ShowAttributeDelocalization ( bool & out_attribute_delocalization ) const

Shows the Attribute Delocalization setting.

Parameters

out_attribute_delocalization

Returns: true if the setting is valid, false otherwise.

◆ ShowExpansion()

bool HPS::SegmentOptimizationOptionsKit::ShowExpansion ( HPS::SegmentOptimizationOptions::Expansion & out_expansion ) const

Shows the Expansion setting.

Parameters

out_expansion

Returns: true if the setting is valid, false otherwise.

◆ ShowMatrix()

bool HPS::SegmentOptimizationOptionsKit::ShowMatrix ( HPS::SegmentOptimizationOptions::Matrix & out_matrix ) const

Shows the Matrix setting.

Parameters

out_matrix

Returns: true if the setting is valid, false otherwise.

◆ ShowReorganization()

bool HPS::SegmentOptimizationOptionsKit::ShowReorganization ( HPS::SegmentOptimizationOptions::Reorganization & out_reorganization ) const

Shows the Reorganization setting.

Parameters

out_reorganization

Returns: true if the setting is valid, false otherwise.

◆ ShowScope()

bool HPS::SegmentOptimizationOptionsKit::ShowScope ( HPS::SegmentOptimizationOptions::Scope & out_scope ) const

Shows the Scope setting.

Parameters

out_scope

Returns: true if the setting is valid, false otherwise.

◆ ShowShellInstancing()

bool HPS::SegmentOptimizationOptionsKit::ShowShellInstancing ( bool & out_shell_instancing ) const

Shows the Shell Instancing setting.

Parameters

out_shell_instancing

Returns: true if the setting is valid, false otherwise.

◆ ShowShellMerging()

bool HPS::SegmentOptimizationOptionsKit::ShowShellMerging ( bool & out_shell_merging ) const

Shows the Shell Merging setting.

Parameters

out_shell_merging

Returns: true if the setting is valid, false otherwise.

◆ ShowUserData()

bool HPS::SegmentOptimizationOptionsKit::ShowUserData ( HPS::SegmentOptimizationOptions::UserData & out_user_data ) const

Shows the User Data setting.

Parameters

out_user_data

Returns: true if the setting is valid, 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.

◆ UnsetAttributeDelocalization()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetAttributeDelocalization ( )

Unsets the ttributeDelocalization value on this kit.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ UnsetEverything()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetExpansion()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetExpansion ( )

Unsets the Expansion value on this kit.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ UnsetMatrix()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetMatrix ( )

Unsets the Matrix value on this kit.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ UnsetReorganization()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetReorganization ( )

Unsets the Reorganization value on this kit.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ UnsetScope()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetScope ( )

Unsets the Scope value on this kit.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ UnsetShellInstancing()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetShellInstancing ( )

Unsets the ShellInstancing value on this kit.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ UnsetShellMerging()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetShellMerging ( )

Unsets the ShellMerging value on this kit.

Returns: A reference to this SegmentOptimizationOptionsKit.

◆ UnsetUserData()

SegmentOptimizationOptionsKit& HPS::SegmentOptimizationOptionsKit::UnsetUserData ( )

Unsets the UserData value on this kit.

Returns: A reference to this SegmentOptimizationOptionsKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::SegmentOptimizationOptionsKit::staticType = HPS::Type::SegmentOptimizationOptionsKit

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

◆ SegmentOptimizationOptionsKit() [1/3]

◆ SegmentOptimizationOptionsKit() [2/3]

◆ SegmentOptimizationOptionsKit() [3/3]

◆ ~SegmentOptimizationOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Consume()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetAttributeDelocalization()

◆ SetExpansion()

◆ SetMatrix()

◆ SetReorganization()

◆ SetScope()

◆ SetShellInstancing()

◆ SetShellMerging()

◆ SetUserData()

◆ Show()

◆ ShowAttributeDelocalization()

◆ ShowExpansion()

◆ ShowMatrix()

◆ ShowReorganization()

◆ ShowScope()

◆ ShowShellInstancing()

◆ ShowShellMerging()

◆ ShowUserData()

◆ Type()

◆ UnsetAttributeDelocalization()

◆ UnsetEverything()

◆ UnsetExpansion()

◆ UnsetMatrix()

◆ UnsetReorganization()

◆ UnsetScope()

◆ UnsetShellInstancing()

◆ UnsetShellMerging()

◆ UnsetUserData()

Member Data Documentation

◆ staticType