#include <sprk_sketchup.h>

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 & | SetHiddenData (bool in_state) |
ImportOptionsKit & | SetMetaData (bool in_state) |
ImportOptionsKit & | SetPortfolio (PortfolioKey const &in_portfolio) |
ImportOptionsKit & | SetTarget (SegmentKey const &in_target, SegmentKey const &in_library) |
ImportOptionsKit & | SetTarget (Model const &in_model) |
ImportOptionsKit & | SetView (View const &in_view) |
void | Show (ImportOptionsKit &out_kit) const |
bool | ShowHiddenData (bool &out_state) const |
bool | ShowMetaData (bool &out_state) const |
bool | ShowPortfolio (PortfolioKey &out_portfolio) const |
bool | ShowTarget (SegmentKey &out_target, SegmentKey &out_library) const |
bool | ShowTarget (Model &out_model) const |
bool | ShowView (View &out_view) const |
ImportOptionsKit & | UnsetEverything () |
ImportOptionsKit & | UnsetHiddenData () |
ImportOptionsKit & | UnsetMetaData () |
ImportOptionsKit & | UnsetPortfolio () |
ImportOptionsKit & | UnsetTarget () |
ImportOptionsKit & | UnsetView () |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
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 () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::SketchupImportOptionsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::SprocketKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
SprocketKit & | operator= (SprocketKit &&in_that) |
SprocketKit (SprocketKit &&in_that) | |
Detailed Description
The ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via Sketchup.
Constructor & Destructor Documentation
HPS::Sketchup::ImportOptionsKit::ImportOptionsKit | ( | ) |
The default constructor creates an empty ImportOptionsKit object.
HPS::Sketchup::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.
HPS::Sketchup::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
|
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.
bool HPS::Sketchup::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.
|
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.
bool HPS::Sketchup::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.
ImportOptionsKit& HPS::Sketchup::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& HPS::Sketchup::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 HPS::Sketchup::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.
void HPS::Sketchup::ImportOptionsKit::Set | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
ImportOptionsKit& HPS::Sketchup::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& HPS::Sketchup::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& HPS::Sketchup::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& HPS::Sketchup::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& HPS::Sketchup::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& HPS::Sketchup::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 HPS::Sketchup::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.
bool HPS::Sketchup::ImportOptionsKit::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 HPS::Sketchup::ImportOptionsKit::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 HPS::Sketchup::ImportOptionsKit::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 HPS::Sketchup::ImportOptionsKit::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 HPS::Sketchup::ImportOptionsKit::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 HPS::Sketchup::ImportOptionsKit::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& HPS::Sketchup::ImportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ImportOptionsKit.
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Sketchup::ImportOptionsKit::UnsetHiddenData | ( | ) |
Removes the Hidden data import state.
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Sketchup::ImportOptionsKit::UnsetMetaData | ( | ) |
Removes the metadata import state.
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Sketchup::ImportOptionsKit::UnsetPortfolio | ( | ) |
Removes the Portfolio import state.
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Sketchup::ImportOptionsKit::UnsetTarget | ( | ) |
Removes the target and library segments, and Model import state.
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::Sketchup::ImportOptionsKit::UnsetView | ( | ) |
Removes the View import state.
- Returns
- A reference to this ImportOptionsKit.
The documentation for this class was generated from the following file:
- include/sprk_sketchup.h