HPS::OBJ::ImportResultsKit Class Reference

#include <hps.h>

Inheritance diagram for HPS::OBJ::ImportResultsKit:
HPS::Kit HPS::Object

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
 
ImportResultsKitoperator= (ImportResultsKit &&in_that)
 
ImportResultsKitoperator= (ImportResultsKit const &in_kit)
 
bool operator== (ImportResultsKit const &in_kit) const
 
void Set (ImportResultsKit const &in_kit)
 
ImportResultsKitSetHandedness (Drawing::Handedness const &in_handedness)
 
ImportResultsKitSetPortfolio (PortfolioKey const &in_portfolio)
 
ImportResultsKitSetSegment (SegmentKey const &in_segment)
 
void Show (ImportResultsKit &out_kit) const
 
bool ShowHandedness (Drawing::Handedness &out_handedness) const
 
bool ShowPortfolio (PortfolioKey &out_portfolio) const
 
bool ShowSegment (SegmentKey &out_segment) const
 
ImportResultsKitUnsetEverything ()
 
ImportResultsKitUnsetHandedness ()
 
ImportResultsKitUnsetPortfolio ()
 
ImportResultsKitUnsetSegment ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::OBJImportResultsKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ImportResultsKit() [1/3]

HPS::OBJ::ImportResultsKit::ImportResultsKit ( )

The default constructor creates an empty ImportResultsKit object.

◆ ImportResultsKit() [2/3]

HPS::OBJ::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_kitThe source ImportResultsKit to copy.

◆ ImportResultsKit() [3/3]

HPS::OBJ::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_thatAn rvalue reference to an ImportResultsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::OBJ::ImportResultsKit::Empty ( ) const
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.

◆ Equals()

bool HPS::OBJ::ImportResultsKit::Equals ( ImportResultsKit const &  in_kit) const

Check if the source ImportResultsKit is equivalent to this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to compare to this ImportResultsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

HPS::Type HPS::OBJ::ImportResultsKit::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::Kit.

◆ operator!=()

bool HPS::OBJ::ImportResultsKit::operator!= ( ImportResultsKit const &  in_kit) const

Check if the source ImportResultsKit is not equivalent to this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to compare to this ImportResultsKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

ImportResultsKit& HPS::OBJ::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_thatAn rvalue reference to an ImportResultsKit to take the impl from.
Returns
A reference to this ImportResultsKit.

◆ operator=() [2/2]

ImportResultsKit& HPS::OBJ::ImportResultsKit::operator= ( ImportResultsKit const &  in_kit)

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to copy.
Returns
A reference to this ImportResultsKit.

◆ operator==()

bool HPS::OBJ::ImportResultsKit::operator== ( ImportResultsKit const &  in_kit) const

Check if the source ImportResultsKit is equivalent to this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to compare to this ImportResultsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::OBJ::ImportResultsKit::Set ( ImportResultsKit const &  in_kit)

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters
in_kitThe source ImportResultsKit to copy.

◆ SetHandedness()

ImportResultsKit& HPS::OBJ::ImportResultsKit::SetHandedness ( Drawing::Handedness const &  in_handedness)

Sets the handedness used when importing geometry. This is really only used when generating an ImportResultsKit which is being returned to a user following an OBJ import.

Parameters
in_handednessHandedness used to import geometry.
Returns
A reference to this ImportResultsKit.

◆ SetPortfolio()

ImportResultsKit& HPS::OBJ::ImportResultsKit::SetPortfolio ( PortfolioKey const &  in_portfolio)

Sets the portfolio which was used when the import file read in images and textures. This is really only used when generating an ImportResultsKit which is being returned to a user following an OBJ import.

Parameters
in_portfolioPortfolio that was used when the file imported images and textures.
Returns
A reference to this ImportResultsKit.

◆ SetSegment()

ImportResultsKit& HPS::OBJ::ImportResultsKit::SetSegment ( SegmentKey const &  in_segment)

Sets the root segment which the OBJ data was imported into. This is really only used when generating an ImportResultsKit which is being returned to a user following an OBJ import.

Parameters
in_segmentSegment the OBJ data was imported into.
Returns
A reference to this ImportResultsKit.

◆ Show()

void HPS::OBJ::ImportResultsKit::Show ( ImportResultsKit out_kit) const

Copies this ImportResultsKit into the given ImportResultsKit.

Parameters
out_kitThe ImportResultsKit to populate with the contents of this ImportResultsKit.

◆ ShowHandedness()

bool HPS::OBJ::ImportResultsKit::ShowHandedness ( Drawing::Handedness out_handedness) const

Shows handedness used to import geometry. This was either the root segment specified by the user in the ImportOptionsKit passed to OBJ::File::Import, or the root segment that was created for this purpose during import.

Parameters
out_handednessSegment the OBJ data was imported into.
Returns
true if a handedness was specified, false otherwise.

◆ ShowPortfolio()

bool HPS::OBJ::ImportResultsKit::ShowPortfolio ( PortfolioKey out_portfolio) const

Shows the portfolio which was used when the import file read in images and textures. This was either the portfolio specified by the user in the ImportOptionsKit passed to OBJ::File::Import, or the portfolio that was created for this purpose during import.

Parameters
in_portfolioPortfolio that was used when the import file read in images and textures.
Returns
true if portfolio was specified, false otherwise.

◆ ShowSegment()

bool HPS::OBJ::ImportResultsKit::ShowSegment ( SegmentKey out_segment) const

Shows the root segment which the OBJ data was imported into. This was either the root segment specified by the user in the ImportOptionsKit passed to OBJ::File::Import, or the root segment that was created for this purpose during import.

Parameters
out_segmentSegment the OBJ data was imported into.
Returns
true if a root segment was specified, false otherwise.

◆ UnsetEverything()

ImportResultsKit& HPS::OBJ::ImportResultsKit::UnsetEverything ( )

Removes all settings from this ImportResultsKit.

Returns
A reference to this ImportResultsKit.

◆ UnsetHandedness()

ImportResultsKit& HPS::OBJ::ImportResultsKit::UnsetHandedness ( )

Removes the handedness used to import geometry. This is really only used when generating an ImportResultsKit which is being returned to a user following an OBJ import.

Returns
A reference to this ImportResultsKit.

◆ UnsetPortfolio()

ImportResultsKit& HPS::OBJ::ImportResultsKit::UnsetPortfolio ( )

Removes the portfolio which was used when the import file imported images and textures. This is really only used when generating an ImportResultsKit which is being returned to a user following an OBJ import.

Returns
A reference to this ImportResultsKit.

◆ UnsetSegment()

ImportResultsKit& HPS::OBJ::ImportResultsKit::UnsetSegment ( )

Removes the root segment which the OBJ data was imported into. This is really only used when generating an ImportResultsKit which is being returned to a user following an OBJ import.

Returns
A reference to this ImportResultsKit.

The documentation for this class was generated from the following file: