HPS::Sketchup::ImportResultsKit

class HPS::Sketchup::ImportResultsKit : public HPS::SprocketKit

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

Public Functions

virtual bool Empty() const

Indicates whether this ImportResultsKit has any values set on it.

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

bool 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.

ImportResultsKit(): The default constructor creates an empty ImportResultsKit object.

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

inline virtual HPS::Type ObjectType() const

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.

bool 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.

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.

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.

bool 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.

void Set(ImportResultsKit const &in_kit)

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters: in_kit – The source ImportResultsKit to copy.

void 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.

bool 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.

bool 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.

bool 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.

bool 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.

bool 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.

bool 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.

virtual ~ImportResultsKit()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::SketchupImportResultsKit