#include <sprk_ooc.h>

Inheritance diagram for HPS::OOC::ImportOptionsKit:

Public Member Functions
bool	Empty () const

bool	Equals (ImportOptionsKit const &in_kit) const

	ImportOptionsKit ()

	ImportOptionsKit (ImportOptionsKit const &in_kit)

	ImportOptionsKit (ImportOptionsKit &&in_that)

HPS::Type	ObjectType () const

bool	operator!= (ImportOptionsKit const &in_kit) const

ImportOptionsKit &	operator= (ImportOptionsKit &&in_that)

ImportOptionsKit &	operator= (ImportOptionsKit const &in_kit)

bool	operator== (ImportOptionsKit const &in_kit) const

void	Set (ImportOptionsKit const &in_kit)

ImportOptionsKit &	SetAreaHighlightTracker (HPS::OOC::AreaHighlightTracker &in_area_highlight_tracker)

ImportOptionsKit &	SetCenterBounding (bool in_center_bounding)

ImportOptionsKit &	SetManualUpdates (bool in_manual_updates)

ImportOptionsKit &	SetTarget (HPS::Model const &in_target)

ImportOptionsKit &	SetTranslation (double in_x, double in_y, double in_z)

void	Show (ImportOptionsKit &out_kit) const

bool	ShowCenterBounding (bool &out_center_bounding) const

bool	ShowManualUpdates (bool &out_manual_updates) const

bool	ShowTarget (HPS::Model &out_model) const

bool	ShowTranslation (double &out_x, double &out_y, double &out_z) const

ImportOptionsKit &	UnsetAreaHighlightTracker ()

ImportOptionsKit &	UnsetCenterBounding ()

ImportOptionsKit &	UnsetEverything ()

ImportOptionsKit &	UnsetManualUpdates ()

ImportOptionsKit &	UnsetTarget ()

ImportOptionsKit &	UnsetTranslation ()

Public Member Functions inherited from HPS::Sprocket
	Sprocket (Sprocket &&in_that)

Public Member Functions inherited from HPS::Object
intptr_t	GetClassID () const

intptr_t	GetInstanceID () const

bool	HasType (HPS::Type in_mask) const

	Object (Object const &that)

	Object (Object &&in_that)

Object &	operator= (Object const &other_object)

Object &	operator= (Object &&in_that)

virtual void	Reset ()

virtual HPS::Type	Type () const

Static Public Member Functions
static ImportOptionsKit	GetDefault ()

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

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

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

Detailed Description

The ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via OOC.

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/3]

HPS::OOC::ImportOptionsKit::ImportOptionsKit ( )

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/3]

HPS::OOC::ImportOptionsKit::ImportOptionsKit ( ImportOptionsKit const & in_kit )

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

Parameters

in_kit The source ImportOptionsKit to copy.

◆ ImportOptionsKit() [3/3]

HPS::OOC::ImportOptionsKit::ImportOptionsKit ( ImportOptionsKit && in_that )

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

Parameters

in_that An rvalue reference to an ImportOptionsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::OOC::ImportOptionsKit::Empty ( ) const

virtual

Indicates whether this ImportOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::OOC::ImportOptionsKit::Equals ( ImportOptionsKit const & in_kit ) const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters

in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.

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

◆ GetDefault()

static ImportOptionsKit HPS::OOC::ImportOptionsKit::GetDefault ( )

static

Creates an ImportOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. These values will be used for import unless an option is overridden by the options passed to File::Import.

Returns: An ImportOptionsKit with the default settings.

◆ ObjectType()

HPS::Type HPS::OOC::ImportOptionsKit::ObjectType ( ) const

inlinevirtual

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.

Reimplemented from HPS::Object.

◆ operator!=()

bool HPS::OOC::ImportOptionsKit::operator!= ( ImportOptionsKit const & in_kit ) const

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

Parameters

in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.

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

◆ operator=() [1/2]

ImportOptionsKit& HPS::OOC::ImportOptionsKit::operator= ( ImportOptionsKit && in_that )

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

Parameters

in_that An rvalue reference to an ImportOptionsKit to take the impl from.

Returns: A reference to this ImportOptionsKit.

◆ operator=() [2/2]

ImportOptionsKit& HPS::OOC::ImportOptionsKit::operator= ( ImportOptionsKit const & in_kit )

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters

in_kit The source ImportOptionsKit to copy.

Returns: A reference to this ImportOptionsKit.

◆ operator==()

bool HPS::OOC::ImportOptionsKit::operator== ( ImportOptionsKit const & in_kit ) const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters

in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.

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

◆ Set()

void HPS::OOC::ImportOptionsKit::Set ( ImportOptionsKit const & in_kit )

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters

in_kit The source ImportOptionsKit to copy.

◆ SetAreaHighlightTracker()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::SetAreaHighlightTracker ( HPS::OOC::AreaHighlightTracker & in_area_highlight_tracker )

Sets the AreaHighlightTracker.

Parameters

in_area_highlight_tracker The AreaHighlightTracker to use for this

Returns: A reference to this ImportOptionsKit.

Note: You should pass in an instance of a class that derives from AreaHighlightTracker that implements your desired behavior.

◆ SetCenterBounding()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::SetCenterBounding ( bool in_center_bounding )

Configures the model set a transform to the center of the bounding.

Parameters

in_center_bounding The new center bounding setting

Returns: A reference to this ImportOptionsKit.

◆ SetManualUpdates()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::SetManualUpdates ( bool in_manual_updates )

Configures the model to only load based on manual updates.

Parameters

in_manual_updates The new manual update setting

Returns: A reference to this ImportOptionsKit.

◆ SetTarget()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::SetTarget ( HPS::Model const & in_target )

Uses the Model to set the root segment, library segment, and portfolio where the data will be imported.

Parameters

in_model Model to use to implicitly set Segment, Library and Portfolio into which the data will be imported.

Returns: A reference to this ImportOptionsKit.

◆ SetTranslation()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::SetTranslation	(	double	in_x,
		double	in_y,
		double	in_z
	)

Configures a translate to be set on the model.

Parameters

in_x	The x translate
in_y	The y translate
in_z	The z translate

Returns: A reference to this ImportOptionsKit.

◆ Show()

void HPS::OOC::ImportOptionsKit::Show ( ImportOptionsKit & out_kit ) const

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters

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

◆ ShowCenterBounding()

bool HPS::OOC::ImportOptionsKit::ShowCenterBounding ( bool & out_center_bounding ) const

Shows if the model is configured to transform to the center of the bounding.

Parameters

out_center_bounding The current center bounding setting

Returns: Returns false if there is no manual update setting.

◆ ShowManualUpdates()

bool HPS::OOC::ImportOptionsKit::ShowManualUpdates ( bool & out_manual_updates ) const

Shows if the model is configured to only load based on manual updates.

Parameters

out_manual_updates The current manual update setting

Returns: Returns false if there is no manual update setting.

◆ ShowTarget()

bool HPS::OOC::ImportOptionsKit::ShowTarget ( HPS::Model & out_model ) const

Shows the root and library segments and portfolio where the data will be imported. If no segments are specified, root segments will be created for this purpose during import.

Parameters

out_model Model to use to implicitly set Segment, Library and Portfolio into which the data will be imported.

Returns: Returns false if there is no target, false otherwise.

◆ ShowTranslation()

bool HPS::OOC::ImportOptionsKit::ShowTranslation	(	double &	out_x,
		double &	out_y,
		double &	out_z
	)		const

Shows if a translate is set.

Parameters

out_x	The x translate
out_y	The y translate
out_z	The z translate

Returns: Returns false if there is no manual update setting.

◆ UnsetAreaHighlightTracker()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::UnsetAreaHighlightTracker ( )

Removes the AreaHighlightTracker.

Returns: A reference to this ImportOptionsKit.

◆ UnsetCenterBounding()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::UnsetCenterBounding ( )

Removes the center bounding setting.

Returns: A reference to this ImportOptionsKit.

◆ UnsetEverything()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::UnsetEverything ( )

Removes all settings from this ImportOptionsKit.

Returns: A reference to this ImportOptionsKit.

◆ UnsetManualUpdates()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::UnsetManualUpdates ( )

Removes the manual update setting.

Returns: A reference to this ImportOptionsKit.

◆ UnsetTarget()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::UnsetTarget ( )

Removes the target and library segments, and Model import state.

Returns: A reference to this ImportOptionsKit.

◆ UnsetTranslation()

ImportOptionsKit& HPS::OOC::ImportOptionsKit::UnsetTranslation ( )

Removes a translate setting.

Returns: A reference to this ImportOptionsKit.

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

include/sprk_ooc.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/3]

◆ ImportOptionsKit() [2/3]

◆ ImportOptionsKit() [3/3]

Member Function Documentation

◆ Empty()

◆ Equals()

◆ GetDefault()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Set()

◆ SetAreaHighlightTracker()

◆ SetCenterBounding()

◆ SetManualUpdates()

◆ SetTarget()

◆ SetTranslation()

◆ Show()

◆ ShowCenterBounding()

◆ ShowManualUpdates()

◆ ShowTarget()

◆ ShowTranslation()

◆ UnsetAreaHighlightTracker()

◆ UnsetCenterBounding()

◆ UnsetEverything()

◆ UnsetManualUpdates()

◆ UnsetTarget()

◆ UnsetTranslation()