API Search || Global Search
HPS::OBJ::ImportOptionsKit Class Reference

#include <hps.h>

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

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
 
ImportOptionsKitoperator= (ImportOptionsKit &&in_that)
 
ImportOptionsKitoperator= (ImportOptionsKit const &in_kit)
 
bool operator== (ImportOptionsKit const &in_kit) const
 
void Set (ImportOptionsKit const &in_kit)
 
ImportOptionsKitSetHandedness (Drawing::Handedness const &in_handedness)
 
ImportOptionsKitSetPortfolio (PortfolioKey const &in_portfolio)
 
ImportOptionsKitSetSegment (SegmentKey const &in_segment)
 
void Show (ImportOptionsKit &out_kit) const
 
bool ShowHandedness (Drawing::Handedness &out_handedness) const
 
bool ShowPortfolio (PortfolioKey &out_portfolio) const
 
bool ShowSegment (SegmentKey &out_segment) const
 
ImportOptionsKitUnsetEverything ()
 
ImportOptionsKitUnsetHandedness ()
 
ImportOptionsKitUnsetPortfolio ()
 
ImportOptionsKitUnsetSegment ()
 
- 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::OBJImportOptionsKit
 
- 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 ImportOptionsKit class contains any settings controlling the import of OBJ files.

Constructor & Destructor Documentation

HPS::OBJ::ImportOptionsKit::ImportOptionsKit ( )

The default constructor creates an empty ImportOptionsKit object.

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

Member Function Documentation

bool HPS::OBJ::ImportOptionsKit::Empty ( ) const
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::OBJ::ImportOptionsKit::Equals ( ImportOptionsKit const &  in_kit) const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
bool HPS::OBJ::ImportOptionsKit::operator!= ( ImportOptionsKit const &  in_kit) const

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

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are not equivalent, false otherwise.
ImportOptionsKit& HPS::OBJ::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_thatAn rvalue reference to an ImportOptionsKit to take the impl from.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::OBJ::ImportOptionsKit::operator= ( ImportOptionsKit const &  in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.
Returns
A reference to this ImportOptionsKit.
bool HPS::OBJ::ImportOptionsKit::operator== ( ImportOptionsKit const &  in_kit) const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
void HPS::OBJ::ImportOptionsKit::Set ( ImportOptionsKit const &  in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.
ImportOptionsKit& HPS::OBJ::ImportOptionsKit::SetHandedness ( Drawing::Handedness const &  in_handedness)

Sets the handedness used to import geometry by the OBJ importer. It should match the World Handedness for best results. Defaults to Right if not set.

Parameters
in_handednessThe handedness used to import geometry.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::OBJ::ImportOptionsKit::SetPortfolio ( PortfolioKey const &  in_portfolio)

Sets the portfolio which will be used when the importing images and textures. If no segment is specified, a portfolio will be created for this purpose during import.

Parameters
in_portfolioPortfolio that will be used when importing images and textures
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::OBJ::ImportOptionsKit::SetSegment ( SegmentKey const &  in_segment)

Sets the root segment where the OBJ data will be imported into. If no segment is specified, a root segment will be created for this purpose during import.

Parameters
in_segmentSegment the OBJ data will be imported into.
Returns
A reference to this ImportOptionsKit.
void HPS::OBJ::ImportOptionsKit::Show ( ImportOptionsKit out_kit) const

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters
out_kitThe ImportOptionsKit to populate with the contents of this ImportOptionsKit.
bool HPS::OBJ::ImportOptionsKit::ShowHandedness ( Drawing::Handedness out_handedness) const

Shows the handedness used to import geometry.

Parameters
out_handednessHandedness used to import geometry.
Returns
true if a handedness was specified, false otherwise.
bool HPS::OBJ::ImportOptionsKit::ShowPortfolio ( PortfolioKey out_portfolio) const

Shows the portfolio which will be used when importing images and textures.

Parameters
out_portfolioPortfolio that will be used when importing images and textures.
Returns
true if a portfolio was specified, false otherwise.
bool HPS::OBJ::ImportOptionsKit::ShowSegment ( SegmentKey out_segment) const

Shows the root segment where the OBJ data will be imported into.

Parameters
out_segmentSegment the OBJ data will be imported into.
Returns
true if a root segment was specified, false otherwise.
ImportOptionsKit& HPS::OBJ::ImportOptionsKit::UnsetEverything ( )

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::OBJ::ImportOptionsKit::UnsetHandedness ( )

Removes handedness information from this kit.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::OBJ::ImportOptionsKit::UnsetPortfolio ( )

Removes the portfolio which will be used when importing images and textures.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::OBJ::ImportOptionsKit::UnsetSegment ( )

Removes the root segment specifying where the OBJ data will be imported into.

Returns
A reference to this ImportOptionsKit.

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