#include <sprk_sketchup.h>
|
static const HPS::Type | staticType = HPS::Type::SketchupImportOptionsKit |
|
static const HPS::Type | staticType = HPS::Type::SprocketKit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via Sketchup.
◆ ImportOptionsKit() [1/3]
HPS::Sketchup::ImportOptionsKit::ImportOptionsKit |
( |
| ) |
|
◆ ImportOptionsKit() [2/3]
HPS::Sketchup::ImportOptionsKit::ImportOptionsKit |
( |
ImportOptionsKit const & |
in_kit | ) |
|
◆ ImportOptionsKit() [3/3]
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
-
◆ Empty()
bool HPS::Sketchup::ImportOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
◆ Equals()
bool HPS::Sketchup::ImportOptionsKit::Equals |
( |
ImportOptionsKit const & |
in_kit | ) |
const |
◆ 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.
◆ ObjectType()
HPS::Type HPS::Sketchup::ImportOptionsKit::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::ImportOptionsKit::operator!= |
( |
ImportOptionsKit const & |
in_kit | ) |
const |
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this ImportOptionsKit.
◆ operator=() [2/2]
◆ operator==()
bool HPS::Sketchup::ImportOptionsKit::operator== |
( |
ImportOptionsKit const & |
in_kit | ) |
const |
◆ Set()
◆ SetHiddenData()
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.
◆ SetMetaData()
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.
◆ SetPortfolio()
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.
◆ SetTarget() [1/2]
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.
◆ SetTarget() [2/2]
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.
◆ SetView()
◆ Show()
◆ ShowHiddenData()
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.
◆ ShowMetaData()
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.
◆ ShowPortfolio()
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.
◆ ShowTarget() [1/2]
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.
◆ ShowTarget() [2/2]
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.
◆ ShowView()
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.
◆ UnsetEverything()
◆ UnsetHiddenData()
Removes the Hidden data import state.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetMetaData()
◆ UnsetPortfolio()
Removes the Portfolio import state.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetTarget()
Removes the target and library segments, and Model import state.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetView()
The documentation for this class was generated from the following file: