Sketchup

class HPS::Sketchup

The Sketchup class contains objects used for importing SketchUp files.

class File

The File class provides functions to import SketchUp files.

Public Static Functions

static ImportNotifier Import(char const *in_file_name, ImportOptionsKit const &in_options)

Performs an asynchronous import of the specified SketchUp file with the provided options. May throw an IOException prior to starting the asynchronous import.

Parameters

in_file_name – The name of the SketchUp file to import.
in_options – The options controlling the import of the SketchUp file.

Returns

An ImportNotfier object that can be used to query the import progress and status.

class ImportNotifier : public HPS::IONotifier 

The ImportNotifier class is a smart-pointer that is tied to a file import. It is used to interact with an ongoing import or get the results from a completed import.

Public Functions

void Assign(ImportNotifier const &in_that)

Associate this ImportNotifier with the same file import as the source ImportNotifier.

Parameters: in_that – The source ImportNotifier for the assignment.

ImportResultsKit GetResults() const

Get the ImportResultsKit for the file import. Throws an IOException if the import is not complete or was not successful.

Returns: The ImportResultsKit for a successful file import.

ImportNotifier(): The default constructor creates an ImportNotifier object which is not tied to any file import.

ImportNotifier(ImportNotifier &&in_that)

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

Parameters: in_that – An rvalue reference to an ImportNotifier to take the impl from.

ImportNotifier(ImportNotifier const &in_that)

The copy constructor creates a new ImportNotifier object that is associated with the same file import as the source ImportNotifier.

Parameters: in_that – The source ImportNotifier to copy.

ImportNotifier(IONotifier const &in_that)

The conversion constructor creates a new derived ImportNotifier object from a base IONotifier object. The copy will only be successful if the source notifier is really an upcast of this notifier type. Otherwise the copy will fail and the resulting ImportNotifier will be invalid.

Parameters: in_that – The source IONotifier 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.

ImportNotifier &operator=(ImportNotifier &&in_that)

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

Parameters: in_that – An rvalue reference to an ImportNotifier to take the impl from.
Returns: A reference to this ImportNotfier.

ImportNotifier &operator=(ImportNotifier const &in_that)

Associate this ImportNotifier with the same file import as the source ImportNotifier.

Parameters: in_that – The source ImportNotifier for the assignment.
Returns: A reference to this ImportNotifier.

virtual ~ImportNotifier()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::SketchupImportNotifier

class ImportOptionsKit : public HPS::SprocketKit 

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

Public Functions

virtual bool Empty() const

Indicates whether this ImportOptionsKit has any values set on it.

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

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

ImportOptionsKit(): The default constructor creates an empty ImportOptionsKit object.

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.

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.

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

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.

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.

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

void Set(ImportOptionsKit const &in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters: in_kit – The source ImportOptionsKit to copy.

ImportOptionsKit &SetHiddenData(bool in_state)

Sets whether to import hidden data from the SketchUp file. Defaults to false.

Parameters: in_state – Whether to import hidden data from the SketchUp file.
Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &SetMetaData(bool in_state)

Sets whether to import metadata from the SketchUp file. Defaults to false.

Parameters: in_state – Whether to import metadata data from the SketchUp file.
Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &SetPortfolio(PortfolioKey const &in_portfolio)

Sets the PortfolioKey where the SketchUp data will be imported into. If no segments are specified, root segments will be created for this purpose during import.

Parameters: in_portfolio – Portfolio the SketchUp data will be imported into.
Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &SetTarget(Model const &in_model)

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

Parameters: in_model – Model to use to implicitly set Segment, Library and Portfolio the SketchUp data will be imported into.
Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &SetTarget(SegmentKey const &in_target, SegmentKey const &in_library)

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

Parameters

in_target – Segment the SketchUp data will be imported into.
in_library – Segment the SketchUp includes data will be imported into.

Returns

A reference to this ImportOptionsKit.

ImportOptionsKit &SetView(View const &in_view)

Sets the View where the default SketchUp camera will be imported into. If no View provided, camera can be retrieved via ImportResultsKit::ShowMainCamera.

Parameters: in_view – View where SketchUp camera will be imported into.
Returns: A reference to this ImportOptionsKit.

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

bool ShowHiddenData(bool &out_state) const

Shows whether to import hidden data from the SketchUp file. Defaults to false.

Parameters: out_state – Whether to import hidden data from the SketchUp file.
Returns: A reference to this ImportOptionsKit.

bool ShowMetaData(bool &out_state) const

Shows whether to import metadata from the SketchUp file. Defaults to false.

Parameters: out_state – Whether to import metadata data from the SketchUp file.
Returns: A reference to this ImportOptionsKit.

bool ShowPortfolio(PortfolioKey &out_portfolio) const

Shows the PortfolioKey where the SketchUp data will be imported into. If no segments are specified, root segments will be created for this purpose during import.

Parameters: out_portfolio – Portfolio the SketchUp data will be imported into.
Returns: A reference to this ImportOptionsKit.

bool ShowTarget(Model &out_model) const

Shows the root and library segments and portfolio where the SketchUp data will be imported into. 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 the SketchUp data will be imported into.
Returns: A reference to this ImportOptionsKit.

bool ShowTarget(SegmentKey &out_target, SegmentKey &out_library) const

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

Parameters

out_target – Segment the SketchUp data will be imported into.
out_library – Segment the SketchUp includes data will be imported into.

Returns

A reference to this ImportOptionsKit.

bool ShowView(View &out_view) const

Shows the view where the SketchUp camera will be imported into.

Parameters: out_view – View where SketchUp camera will be imported into.
Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetEverything()

Removes all settings from this ImportOptionsKit.

Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetHiddenData()

Removes the Hidden data import state.

Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetMetaData()

Removes the metadata import state.

Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetPortfolio()

Removes the Portfolio import state.

Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetTarget()

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

Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetView()

Removes the View import state.

Returns: A reference to this ImportOptionsKit.

virtual ~ImportOptionsKit()

Public Static Functions

static ImportOptionsKit GetDefault()

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.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::SketchupImportOptionsKit

class 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