HPS::Sketchup::ImportResultsKit Class Reference

#include <sprk_sketchup.h>

Inheritance diagram for HPS::Sketchup::ImportResultsKit:

Public Member Functions
bool	Empty () const
bool	Equals (ImportResultsKit const &in_kit) const
	ImportResultsKit ()
	ImportResultsKit (ImportResultsKit const &in_kit)
	ImportResultsKit (ImportResultsKit &&in_that)
HPS::Type	ObjectType () const
bool	operator!= (ImportResultsKit const &in_kit) const
ImportResultsKit &	operator= (ImportResultsKit &&in_that)
ImportResultsKit &	operator= (ImportResultsKit const &in_kit)
bool	operator== (ImportResultsKit const &in_kit) const
void	Set (ImportResultsKit const &in_kit)
void	Show (ImportResultsKit &out_kit) const
bool	ShowMainCamera (HPS::CameraKit &out_camera) const
bool	ShowPortfolio (PortfolioKey &out_portfolio) const
bool	ShowScenes (HPS::UTF8Array &out_names, HPS::CameraKitArray &out_cameras) const
bool	ShowTarget (SegmentKey &out_target, SegmentKey &out_library) const
bool	ShowTarget (Model &out_model) const
bool	ShowView (View &out_view) const
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 Attributes
static const HPS::Type	staticType = HPS::Type::SketchupImportResultsKit
Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type	staticType = HPS::Type::SprocketKit
Static Public Attributes inherited from HPS::Object
static const HPS::Type	staticType = HPS::Type::None

Additional Inherited Members
Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t	ClassID ()
Protected Member Functions inherited from HPS::SprocketKit
SprocketKit &	operator= (SprocketKit &&in_that)
	SprocketKit (SprocketKit &&in_that)

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.

Member Function Documentation

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.

ObjectType()

HPS::Type HPS::Sketchup::ImportResultsKit::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::SprocketKit.

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.

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.

---

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

• include/sprk_sketchup.h