HPS::Sketchup::ImportResultsKit Class Reference

The ImportResultsKit class contains the results of a successful SketchUp import. More...

#include <sprk_sketchup.h>

Inheritance diagram for HPS::Sketchup::ImportResultsKit:

Collaboration diagram for HPS::Sketchup::ImportResultsKit:

Public Member Functions
	ImportResultsKit ()
	The default constructor creates an empty ImportResultsKit object. More...
	ImportResultsKit (ImportResultsKit const &in_kit)
	The copy constructor creates a new ImportResultsKit object that contains the same settings as the source ImportResultsKit. More...
	ImportResultsKit (ImportResultsKit &&in_that)
	The move constructor creates an ImportResultsKit by transferring the underlying impl of the rvalue reference to this ImportResultsKit thereby avoiding a copy and allocation. More...
ImportResultsKit &	operator= (ImportResultsKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this ImportResultsKit thereby avoiding a copy. More...
virtual	~ImportResultsKit ()
HPS::Type	ObjectType () const
void	Set (ImportResultsKit const &in_kit)
	Copies the source ImportResultsKit into this ImportResultsKit. More...
void	Show (ImportResultsKit &out_kit) const
	Copies this ImportResultsKit into the given ImportResultsKit. More...
ImportResultsKit &	operator= (ImportResultsKit const &in_kit)
	Copies the source ImportResultsKit into this ImportResultsKit. More...
bool	Empty () const
	Indicates whether this ImportResultsKit has any values set on it. More...
bool	Equals (ImportResultsKit const &in_kit) const
	Check if the source ImportResultsKit is equivalent to this ImportResultsKit. More...
bool	operator== (ImportResultsKit const &in_kit) const
	Check if the source ImportResultsKit is equivalent to this ImportResultsKit. More...
bool	operator!= (ImportResultsKit const &in_kit) const
	Check if the source ImportResultsKit is not equivalent to this ImportResultsKit. More...
bool	ShowTarget (SegmentKey &out_target, SegmentKey &out_library) const
	Shows the root and library segments where the SketchUp data was imported into. More...
bool	ShowTarget (Model &out_model) const
	Shows the Model where the SketchUp data was imported into. More...
bool	ShowPortfolio (PortfolioKey &out_portfolio) const
	Shows the PortfolioKey where the SketchUp data was imported into. More...
bool	ShowView (View &out_view) const
	Shows the view where the main SketchUp camera was imported into. More...
bool	ShowMainCamera (HPS::CameraKit &out_camera) const
	Shows the camera where the main SketchUp camera was imported into. More...
bool	ShowScenes (HPS::UTF8Array &out_names, HPS::CameraKitArray &out_cameras) const
	Shows the scenes imported from SketchUp. 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::SketchupImportResultsKit

Detailed Description

The ImportResultsKit class contains the results of a successful SketchUp import.

Constructor & Destructor Documentation

ImportResultsKit() [1/3]

HPS::Sketchup::ImportResultsKit::ImportResultsKit

(

)

The default constructor creates an empty ImportResultsKit object.

ImportResultsKit() [2/3]

HPS::Sketchup::ImportResultsKit::ImportResultsKit

(

ImportResultsKit const &

in_kit

)

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

Parameters

in_kit

The source ImportResultsKit to copy.

ImportResultsKit() [3/3]

HPS::Sketchup::ImportResultsKit::ImportResultsKit

(

ImportResultsKit &&

in_that

)

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

Parameters

in_that

An rvalue reference to an ImportResultsKit to take the impl from.

~ImportResultsKit()

virtual HPS::Sketchup::ImportResultsKit::~ImportResultsKit ( )

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::Sketchup::ImportResultsKit::Empty ( ) const

virtual

Indicates whether this ImportResultsKit has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::Sketchup::ImportResultsKit::Equals

(

ImportResultsKit const &

in_kit

)

const

Check if the source ImportResultsKit is equivalent to this ImportResultsKit.

Parameters

in_kit

The source ImportResultsKit to compare to this ImportResultsKit.

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

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Sketchup::ImportResultsKit::operator!=

(

ImportResultsKit const &

in_kit

)

const

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

Parameters

in_kit

The source ImportResultsKit to compare to this ImportResultsKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

ImportResultsKit& HPS::Sketchup::ImportResultsKit::operator=

(

ImportResultsKit &&

in_that

)

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

Parameters

in_that

An rvalue reference to an ImportResultsKit to take the impl from.

Returns

A reference to this ImportResultsKit.

operator=() [2/2]

ImportResultsKit& HPS::Sketchup::ImportResultsKit::operator=

(

ImportResultsKit const &

in_kit

)

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters

in_kit

The source ImportResultsKit to copy.

Returns

A reference to this ImportResultsKit.

operator==()

bool HPS::Sketchup::ImportResultsKit::operator==

(

ImportResultsKit const &

in_kit

)

const

Check if the source ImportResultsKit is equivalent to this ImportResultsKit.

Parameters

in_kit

The source ImportResultsKit to compare to this ImportResultsKit.

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::Sketchup::ImportResultsKit::Set

(

ImportResultsKit const &

in_kit

)

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters

in_kit

The source ImportResultsKit to copy.

Show()

void HPS::Sketchup::ImportResultsKit::Show

(

ImportResultsKit &

out_kit

)

const

Copies this ImportResultsKit into the given ImportResultsKit.

Parameters

out_kit

The ImportResultsKit to populate with the contents of this ImportResultsKit.

ShowMainCamera()

bool HPS::Sketchup::ImportResultsKit::ShowMainCamera

(

HPS::CameraKit &

out_camera

)

const

Shows the camera where the main SketchUp camera was imported into.

Parameters

out_camera

CameraKit where main SketchUp camera was imported into

Returns

true if a valid camera was imported, false otherwise.

ShowPortfolio()

bool HPS::Sketchup::ImportResultsKit::ShowPortfolio

(

PortfolioKey &

out_portfolio

)

const

Shows the PortfolioKey where the SketchUp data was imported into.

Parameters

out_portfolio

Portfolio the SketchUp data was imported into.

Returns

true if a valid Portfolio is set, false otherwise.

ShowScenes()

bool HPS::Sketchup::ImportResultsKit::ShowScenes	(	HPS::UTF8Array &	out_names,
		HPS::CameraKitArray &	out_cameras
	)		const

Shows the scenes imported from SketchUp.

Parameters

out_names	UTF8Array where SketchUp scene names were imported into.
out_cameras	CameraKitArray where SketchUp scene cameras were imported into.

Returns

true if valid names and cameras are set, false otherwise.

ShowTarget() [1/2]

bool HPS::Sketchup::ImportResultsKit::ShowTarget	(	SegmentKey &	out_target,
		SegmentKey &	out_library
	)		const

Shows the root and library segments where the SketchUp data was imported into.

Parameters

out_target	Segment the SketchUp data was imported into.
out_library	Segment the SketchUp includes data was imported into.

Returns

true if a valid target and library segment are set, false otherwise.

ShowTarget() [2/2]

bool HPS::Sketchup::ImportResultsKit::ShowTarget

(

Model &

out_model

)

const

Shows the Model where the SketchUp data was imported into.

Parameters

out_model

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

Returns

true if a Model was specified on import, false otherwise.

ShowView()

bool HPS::Sketchup::ImportResultsKit::ShowView

(

View &

out_view

)

const

Shows the view where the main SketchUp camera was imported into.

Parameters

out_view

View where main SketchUp camera was imported into.

Returns

true if a View was specified on import, 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::Sketchup::ImportResultsKit::staticType = HPS::Type::SketchupImportResultsKit

static

---

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

• sprk_sketchup.h