HPS::Exchange::ExportU3DOptionsKit Class Reference

The HPS::Exchange::ExportU3DOptionsKit class is a user space object. More...

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ExportU3DOptionsKit:

Collaboration diagram for HPS::Exchange::ExportU3DOptionsKit:

Public Member Functions
	ExportU3DOptionsKit ()
	The default constructor creates an empty ExportU3DOptionsKit object. More...
	ExportU3DOptionsKit (ExportU3DOptionsKit const &in_kit)
	The copy constructor creates a new ExportU3DOptionsKit object that contains the same settings as the source ExportU3DOptionsKit. More...
	ExportU3DOptionsKit (ExportU3DOptionsKit &&in_that)
	The move constructor creates an ExportU3DOptionsKit by transferring the underlying object of the rvalue reference to this ExportU3DOptionsKit. More...
virtual	~ExportU3DOptionsKit ()
HPS::Type	ObjectType () const
void	Set (ExportU3DOptionsKit const &in_kit)
	Copies the source ExportU3DOptionsKit into this ExportU3DOptionsKit. More...
void	Show (ExportU3DOptionsKit &out_kit) const
	Copies this ExportU3DOptionsKit into the given ExportU3DOptionsKit. More...
ExportU3DOptionsKit &	operator= (ExportU3DOptionsKit const &in_kit)
	Copies the source ExportU3DOptionsKit into this ExportU3DOptionsKit. More...
ExportU3DOptionsKit &	operator= (ExportU3DOptionsKit &&in_that)
	The move assignment operator transfers the underlying object of the rvalue reference to this ExportU3DOptionsKit. More...
bool	Empty () const
	Indicates whether this ExportU3DOptionsKit has any values set on it. More...
bool	Equals (ExportU3DOptionsKit const &in_kit) const
	Check if the source ExportU3DOptionsKit is equivalent to this ExportU3DOptionsKit. More...
bool	operator== (ExportU3DOptionsKit const &in_kit) const
	Check if the source ExportU3DOptionsKit is equivalent to this ExportU3DOptionsKit. More...
bool	operator!= (ExportU3DOptionsKit const &in_kit) const
	Check if the source ExportU3DOptionsKit is not equivalent to this ExportU3DOptionsKit. More...
ExportU3DOptionsKit &	SetVersion (U3D::Version in_version)
	Sets the version of the U3D data to export. More...
ExportU3DOptionsKit &	SetCompression (unsigned char in_level)
	Sets the level of compression to apply to tessellations in the U3D data for export. More...
ExportU3DOptionsKit &	UnsetVersion ()
	Removes the version setting. More...
ExportU3DOptionsKit &	UnsetCompression ()
	Removes the compression setting. More...
ExportU3DOptionsKit &	UnsetEverything ()
	Removes all settings from this ExportU3DOptionsKit. More...
bool	ShowVersion (U3D::Version &out_version) const
	Shows the version setting. More...
bool	ShowCompression (unsigned char &out_level) const
	Shows the compression setting. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...
bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...
intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...
intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static ExportU3DOptionsKit	GetDefault ()
	Creates an ExportU3DOptionsKit which contains the default settings. More...
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::ExchangeExportU3DOptionsKit

Detailed Description

The HPS::Exchange::ExportU3DOptionsKit class is a user space object.

It contains settings controlling how U3D data is exported via Exchange. Calling HPS::Exchange::ExportU3DOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

ExportU3DOptionsKit() [1/3]

HPS::Exchange::ExportU3DOptionsKit::ExportU3DOptionsKit

(

)

The default constructor creates an empty ExportU3DOptionsKit object.

ExportU3DOptionsKit() [2/3]

HPS::Exchange::ExportU3DOptionsKit::ExportU3DOptionsKit

(

ExportU3DOptionsKit const &

in_kit

)

The copy constructor creates a new ExportU3DOptionsKit object that contains the same settings as the source ExportU3DOptionsKit.

Parameters

in_kit

The source ExportU3DOptionsKit to copy.

ExportU3DOptionsKit() [3/3]

HPS::Exchange::ExportU3DOptionsKit::ExportU3DOptionsKit

(

ExportU3DOptionsKit &&

in_that

)

The move constructor creates an ExportU3DOptionsKit by transferring the underlying object of the rvalue reference to this ExportU3DOptionsKit.

Parameters

in_that

An rvalue reference to an ExportU3DOptionsKit to take the underlying object from.

~ExportU3DOptionsKit()

virtual HPS::Exchange::ExportU3DOptionsKit::~ExportU3DOptionsKit ( )

virtual

Member Function Documentation

ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

Empty()

bool HPS::Exchange::ExportU3DOptionsKit::Empty ( ) const

virtual

Indicates whether this ExportU3DOptionsKit has any values set on it.

Returns

true if no values are set on this ExportU3DOptionsKit, false otherwise.

Reimplemented from HPS::Object.

Equals()

bool HPS::Exchange::ExportU3DOptionsKit::Equals

(

ExportU3DOptionsKit const &

in_kit

)

const

Check if the source ExportU3DOptionsKit is equivalent to this ExportU3DOptionsKit.

Parameters

in_kit

The source ExportU3DOptionsKit to compare to this ExportU3DOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns

A unique value shared by all objects of the same class.

GetDefault()

static ExportU3DOptionsKit HPS::Exchange::ExportU3DOptionsKit::GetDefault ( )

static

Creates an ExportU3DOptionsKit 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::ExportU3D.

Returns

An ExportU3DOptionsKit with the default settings.

GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns

A value unique to an instance of an object and all objects that are backed by the same database resource.

HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask

The Type mask to check against this Object.

Returns

true if this Object has the given Type mask, false otherwise.

ObjectType()

HPS::Type HPS::Exchange::ExportU3DOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Exchange::ExportU3DOptionsKit::operator!=

(

ExportU3DOptionsKit const &

in_kit

)

const

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

Parameters

in_kit

The source ExportU3DOptionsKit to compare to this ExportU3DOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

ExportU3DOptionsKit& HPS::Exchange::ExportU3DOptionsKit::operator=

(

ExportU3DOptionsKit const &

in_kit

)

Copies the source ExportU3DOptionsKit into this ExportU3DOptionsKit.

Parameters

in_kit

The source ExportU3DOptionsKit to copy.

Returns

A reference to this ExportU3DOptionsKit.

operator=() [2/2]

ExportU3DOptionsKit& HPS::Exchange::ExportU3DOptionsKit::operator=

(

ExportU3DOptionsKit &&

in_that

)

The move assignment operator transfers the underlying object of the rvalue reference to this ExportU3DOptionsKit.

Parameters

in_that

An rvalue reference to an ExportU3DOptionsKit to take the underlying object from.

Returns

A reference to this ExportU3DOptionsKit.

operator==()

bool HPS::Exchange::ExportU3DOptionsKit::operator==

(

ExportU3DOptionsKit const &

in_kit

)

const

Check if the source ExportU3DOptionsKit is equivalent to this ExportU3DOptionsKit.

Parameters

in_kit

The source ExportU3DOptionsKit to compare to this ExportU3DOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

Set()

void HPS::Exchange::ExportU3DOptionsKit::Set

(

ExportU3DOptionsKit const &

in_kit

)

Copies the source ExportU3DOptionsKit into this ExportU3DOptionsKit.

Parameters

in_kit

The source ExportU3DOptionsKit to copy.

SetCompression()

ExportU3DOptionsKit& HPS::Exchange::ExportU3DOptionsKit::SetCompression

(

unsigned char

in_level

)

Sets the level of compression to apply to tessellations in the U3D data for export.

If no compression level is set, no compression will be applied. This corresponds to the value that will be passed to A3DRWParamsExportU3DData::m_ucMeshQualityValue.

Parameters

in_level

The level of compression to apply to tessellations in the U3D data for export. This value should be in the range [0, 100].

Returns

A reference to this ExportU3DOptionsKit.

SetVersion()

ExportU3DOptionsKit& HPS::Exchange::ExportU3DOptionsKit::SetVersion

(

U3D::Version

in_version

)

Sets the version of the U3D data to export.

This corresponds to the value that will be passed to A3DRWParamsExportU3DData::m_eU3DVersion.

Parameters

in_version

The version of the U3D data to export.

Returns

A reference to this ExportU3DOptionsKit.

See also

Default value

Show()

void HPS::Exchange::ExportU3DOptionsKit::Show

(

ExportU3DOptionsKit &

out_kit

)

const

Copies this ExportU3DOptionsKit into the given ExportU3DOptionsKit.

Parameters

out_kit

The ExportU3DOptionsKit to populate with the contents of this ExportU3DOptionsKit.

ShowCompression()

bool HPS::Exchange::ExportU3DOptionsKit::ShowCompression

(

unsigned char &

out_level

)

const

Shows the compression setting.

Parameters

out_level

The level of compression to apply to tessellations in the U3D data for export.

Returns

true if a compression setting was specified, false otherwise.

ShowVersion()

bool HPS::Exchange::ExportU3DOptionsKit::ShowVersion

(

U3D::Version &

out_version

)

const

Shows the version setting.

Parameters

out_version

The version of the U3D data to export.

Returns

true if a version setting was specified, false otherwise.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns

The true type of the object in question.

Reimplemented in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

UnsetCompression()

ExportU3DOptionsKit& HPS::Exchange::ExportU3DOptionsKit::UnsetCompression

(

)

Removes the compression setting.

Returns

A reference to this ExportU3DOptionsKit.

UnsetEverything()

ExportU3DOptionsKit& HPS::Exchange::ExportU3DOptionsKit::UnsetEverything

(

)

Removes all settings from this ExportU3DOptionsKit.

Returns

A reference to this ExportU3DOptionsKit.

UnsetVersion()

ExportU3DOptionsKit& HPS::Exchange::ExportU3DOptionsKit::UnsetVersion

(

)

Removes the version setting.

Returns

A reference to this ExportU3DOptionsKit.

Member Data Documentation

staticType

const HPS::Type HPS::Exchange::ExportU3DOptionsKit::staticType = HPS::Type::ExchangeExportU3DOptionsKit

static

---

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

• sprk_exchange.h