#include <sprk_sketchup.h>

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 |
![]() | |
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 Attributes | |
static const HPS::Type | staticType = HPS::Type::SketchupImportResultsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::SprocketKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
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
HPS::Sketchup::ImportResultsKit::ImportResultsKit | ( | ) |
The default constructor creates an empty ImportResultsKit object.
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.
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
|
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.
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.
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.
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.
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.
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.
void HPS::Sketchup::ImportResultsKit::Set | ( | ImportResultsKit const & | in_kit | ) |
Copies the source ImportResultsKit into this ImportResultsKit.
- Parameters
-
in_kit The source ImportResultsKit to copy.
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.
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.
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.
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.
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.
bool HPS::Sketchup::ImportResultsKit::ShowTarget | ( | Model & | out_model | ) | const |
bool HPS::Sketchup::ImportResultsKit::ShowView | ( | View & | out_view | ) | const |
The documentation for this class was generated from the following file:
- include/sprk_sketchup.h