HPS::Exchange::ExportPRCOptionsKit Class Reference

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

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ExportPRCOptionsKit:

Collaboration diagram for HPS::Exchange::ExportPRCOptionsKit:

Public Member Functions
	ExportPRCOptionsKit ()
	The default constructor creates an empty ExportPRCOptionsKit object. More...
	ExportPRCOptionsKit (ExportPRCOptionsKit const &in_kit)
	The copy constructor creates a new ExportPRCOptionsKit object that contains the same settings as the source ExportPRCOptionsKit. More...
	ExportPRCOptionsKit (ExportPRCOptionsKit &&in_that)
	The move constructor creates an ExportPRCOptionsKit by transferring the underlying object of the rvalue reference to this ExportPRCOptionsKit. More...
virtual	~ExportPRCOptionsKit ()
HPS::Type	ObjectType () const
void	Set (ExportPRCOptionsKit const &in_kit)
	Copies the source ExportPRCOptionsKit into this ExportPRCOptionsKit. More...
void	Show (ExportPRCOptionsKit &out_kit) const
	Copies this ExportPRCOptionsKit into the given ExportPRCOptionsKit. More...
ExportPRCOptionsKit &	operator= (ExportPRCOptionsKit const &in_kit)
	Copies the source ExportPRCOptionsKit into this ExportPRCOptionsKit. More...
ExportPRCOptionsKit &	operator= (ExportPRCOptionsKit &&in_that)
	The move assignment operator transfers the underlying object of the rvalue reference to this ExportPRCOptionsKit. More...
bool	Empty () const
	Indicates whether this ExportPRCOptionsKit has any values set on it. More...
bool	Equals (ExportPRCOptionsKit const &in_kit) const
	Check if the source ExportPRCOptionsKit is equivalent to this ExportPRCOptionsKit. More...
bool	operator== (ExportPRCOptionsKit const &in_kit) const
	Check if the source ExportPRCOptionsKit is equivalent to this ExportPRCOptionsKit. More...
bool	operator!= (ExportPRCOptionsKit const &in_kit) const
	Check if the source ExportPRCOptionsKit is not equivalent to this ExportPRCOptionsKit. More...
ExportPRCOptionsKit &	SetTessellationCompression (bool in_state)
	Sets whether to compress tessellation for export. More...
ExportPRCOptionsKit &	SetBRepCompression (PRC::BRepCompression in_level)
	Sets the level of compression to apply to BRep data for export. More...
ExportPRCOptionsKit &	SetBRepRemoval (bool in_state)
	Sets whether to remove the BRep information for export. More...
ExportPRCOptionsKit &	SetAttributeRemoval (bool in_state)
	Sets whether to remove the attribute information for export. More...
ExportPRCOptionsKit &	SetAdditionalKeyPaths (KeyPathArray const &in_additional_key_paths)
	Sets an array of key paths which will be exported to PRC in addition to the model. More...
ExportPRCOptionsKit &	SetAdditionalKeyPaths (size_t in_count, KeyPath const in_additional_key_paths [])
	Sets an array of key paths which will be exported to PRC in addition to the model. More...
ExportPRCOptionsKit &	UnsetTessellationCompression ()
	Removes the tessellation compression setting. More...
ExportPRCOptionsKit &	UnsetBRepCompression ()
	Removes the BRep compression level setting. More...
ExportPRCOptionsKit &	UnsetBRepRemoval ()
	Removes the BRep removal setting. More...
ExportPRCOptionsKit &	UnsetAttributeRemoval ()
	Removes the attribute removal setting. More...
ExportPRCOptionsKit &	UnsetAdditionalKeyPaths ()
	Removes the additional key paths setting. More...
ExportPRCOptionsKit &	UnsetEverything ()
	Removes all settings from this ExportPRCOptionsKit. More...
bool	ShowTessellationCompression (bool &out_state) const
	Shows the tessellation compression setting. More...
bool	ShowBRepCompression (PRC::BRepCompression &out_level) const
	Shows the BRep compression level setting. More...
bool	ShowBRepRemoval (bool &out_state) const
	Shows the BRep removal setting. More...
bool	ShowAttributeRemoval (bool &out_state) const
	Shows the attribute removal setting. More...
bool	ShowAdditionalKeyPaths (KeyPathArray &out_additional_key_paths) const
	Shows the additional key paths 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 ExportPRCOptionsKit	GetDefault ()
	Creates an ExportPRCOptionsKit 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::ExchangeExportPRCOptionsKit

Detailed Description

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

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

Constructor & Destructor Documentation

ExportPRCOptionsKit() [1/3]

HPS::Exchange::ExportPRCOptionsKit::ExportPRCOptionsKit

(

)

The default constructor creates an empty ExportPRCOptionsKit object.

ExportPRCOptionsKit() [2/3]

HPS::Exchange::ExportPRCOptionsKit::ExportPRCOptionsKit

(

ExportPRCOptionsKit const &

in_kit

)

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

Parameters

in_kit

The source ExportPRCOptionsKit to copy.

ExportPRCOptionsKit() [3/3]

HPS::Exchange::ExportPRCOptionsKit::ExportPRCOptionsKit

(

ExportPRCOptionsKit &&

in_that

)

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

Parameters

in_that

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

~ExportPRCOptionsKit()

virtual HPS::Exchange::ExportPRCOptionsKit::~ExportPRCOptionsKit ( )

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::ExportPRCOptionsKit::Empty ( ) const

virtual

Indicates whether this ExportPRCOptionsKit has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::Exchange::ExportPRCOptionsKit::Equals

(

ExportPRCOptionsKit const &

in_kit

)

const

Check if the source ExportPRCOptionsKit is equivalent to this ExportPRCOptionsKit.

Parameters

in_kit

The source ExportPRCOptionsKit to compare to this ExportPRCOptionsKit.

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 ExportPRCOptionsKit HPS::Exchange::ExportPRCOptionsKit::GetDefault ( )

static

Creates an ExportPRCOptionsKit 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::ExportPRC.

Returns

An ExportPRCOptionsKit 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::ExportPRCOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Exchange::ExportPRCOptionsKit::operator!=

(

ExportPRCOptionsKit const &

in_kit

)

const

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

Parameters

in_kit

The source ExportPRCOptionsKit to compare to this ExportPRCOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

ExportPRCOptionsKit& HPS::Exchange::ExportPRCOptionsKit::operator=

(

ExportPRCOptionsKit const &

in_kit

)

Copies the source ExportPRCOptionsKit into this ExportPRCOptionsKit.

Parameters

in_kit

The source ExportPRCOptionsKit to copy.

Returns

A reference to this ExportPRCOptionsKit.

operator=() [2/2]

ExportPRCOptionsKit& HPS::Exchange::ExportPRCOptionsKit::operator=

(

ExportPRCOptionsKit &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this ExportPRCOptionsKit.

operator==()

bool HPS::Exchange::ExportPRCOptionsKit::operator==

(

ExportPRCOptionsKit const &

in_kit

)

const

Check if the source ExportPRCOptionsKit is equivalent to this ExportPRCOptionsKit.

Parameters

in_kit

The source ExportPRCOptionsKit to compare to this ExportPRCOptionsKit.

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::ExportPRCOptionsKit::Set

(

ExportPRCOptionsKit const &

in_kit

)

Copies the source ExportPRCOptionsKit into this ExportPRCOptionsKit.

Parameters

in_kit

The source ExportPRCOptionsKit to copy.

SetAdditionalKeyPaths() [1/2]

ExportPRCOptionsKit& HPS::Exchange::ExportPRCOptionsKit::SetAdditionalKeyPaths

(

KeyPathArray const &

in_additional_key_paths

)

Sets an array of key paths which will be exported to PRC in addition to the model.

Use this setting to export Visualize geometry to PRC.

Parameters

in_additional_key_paths

The key paths to be exported.

Returns

A reference to this AnnotationKit.

SetAdditionalKeyPaths() [2/2]

ExportPRCOptionsKit& HPS::Exchange::ExportPRCOptionsKit::SetAdditionalKeyPaths	(	size_t	in_count,
		KeyPath const	in_additional_key_paths[]
	)

Sets an array of key paths which will be exported to PRC in addition to the model.

Use this setting to export Visualize geometry to PRC.

Parameters

in-count	The number of key paths contained in in_additional_key_paths.
in_additional_key_paths	The key paths to be exported.

Returns

A reference to this AnnotationKit.

SetAttributeRemoval()

ExportPRCOptionsKit& HPS::Exchange::ExportPRCOptionsKit::SetAttributeRemoval

(

bool

in_state

)

Sets whether to remove the attribute information for export.

This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bRemoveAttributes.

Parameters

in_state

Whether to remove the attribute information in the PRC data for this annotation.

Returns

A reference to this AnnotationKit.

See also

Default value

SetBRepCompression()

ExportPRCOptionsKit& HPS::Exchange::ExportPRCOptionsKit::SetBRepCompression

(

PRC::BRepCompression

in_level

)

Sets the level of compression to apply to BRep data for export.

This corresponds to the values that will be passed to A3DRWParamsExportPrcData::m_bCompressBrep and A3DRWParamsExportPrcData::m_eCompressBrepType.

Parameters

in_level

The level of compression to apply to BRep data for export.

Returns

A reference to this ExportPRCOptionsKit.

See also

Default value

SetBRepRemoval()

ExportPRCOptionsKit& HPS::Exchange::ExportPRCOptionsKit::SetBRepRemoval

(

bool

in_state

)

Sets whether to remove the BRep information for export.

This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bRemoveBRep.

Parameters

in_state

Whether to remove BRep information in the PRC data for this annotation.

Returns

A reference to this AnnotationKit.

See also

Default value

SetTessellationCompression()

ExportPRCOptionsKit& HPS::Exchange::ExportPRCOptionsKit::SetTessellationCompression

(

bool

in_state

)

Sets whether to compress tessellation for export.

This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bCompressTessellation.

Parameters

in_state

Whether to compress tessellation for export.

Returns

A reference to this ExportPRCOptionsKit.

See also

Default value

Show()

void HPS::Exchange::ExportPRCOptionsKit::Show

(

ExportPRCOptionsKit &

out_kit

)

const

Copies this ExportPRCOptionsKit into the given ExportPRCOptionsKit.

Parameters

out_kit

The ExportPRCOptionsKit to populate with the contents of this ExportPRCOptionsKit.

ShowAdditionalKeyPaths()

bool HPS::Exchange::ExportPRCOptionsKit::ShowAdditionalKeyPaths

(

KeyPathArray &

out_additional_key_paths

)

const

Shows the additional key paths setting.

Parameters

out_additional_key_paths

The key paths which will be added to the model

Returns

true if an additional key paths setting was specified, false otherwise.

ShowAttributeRemoval()

bool HPS::Exchange::ExportPRCOptionsKit::ShowAttributeRemoval

(

bool &

out_state

)

const

Shows the attribute removal setting.

Parameters

out_state

Whether to remove attribute information for export.

Returns

true if an attribute removal setting was specified, false otherwise.

ShowBRepCompression()

bool HPS::Exchange::ExportPRCOptionsKit::ShowBRepCompression

(

PRC::BRepCompression &

out_level

)

const

Shows the BRep compression level setting.

Parameters

out_level

The level of compression to apply to BRep data for export.

Returns

true if a BRep compression level setting was specified, false otherwise.

ShowBRepRemoval()

bool HPS::Exchange::ExportPRCOptionsKit::ShowBRepRemoval

(

bool &

out_state

)

const

Shows the BRep removal setting.

Parameters

out_state

Whether to remove BRep information for export.

Returns

true if a BRep removal setting was specified, false otherwise.

ShowTessellationCompression()

bool HPS::Exchange::ExportPRCOptionsKit::ShowTessellationCompression

(

bool &

out_state

)

const

Shows the tessellation compression setting.

Parameters

out_state

Whether to compress tessellation for export.

Returns

true if a tessellation compression 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.

UnsetAdditionalKeyPaths()

ExportPRCOptionsKit& HPS::Exchange::ExportPRCOptionsKit::UnsetAdditionalKeyPaths

(

)

Removes the additional key paths setting.

Returns

A reference to this ExportPRCOptionsKit.

UnsetAttributeRemoval()

ExportPRCOptionsKit& HPS::Exchange::ExportPRCOptionsKit::UnsetAttributeRemoval

(

)

Removes the attribute removal setting.

Returns

A reference to this ExportPRCOptionsKit.

UnsetBRepCompression()

ExportPRCOptionsKit& HPS::Exchange::ExportPRCOptionsKit::UnsetBRepCompression

(

)

Removes the BRep compression level setting.

Returns

A reference to this ExportPRCOptionsKit.

UnsetBRepRemoval()

ExportPRCOptionsKit& HPS::Exchange::ExportPRCOptionsKit::UnsetBRepRemoval

(

)

Removes the BRep removal setting.

Returns

A reference to this ExportPRCOptionsKit.

UnsetEverything()

ExportPRCOptionsKit& HPS::Exchange::ExportPRCOptionsKit::UnsetEverything

(

)

Removes all settings from this ExportPRCOptionsKit.

Returns

A reference to this ExportPRCOptionsKit.

UnsetTessellationCompression()

ExportPRCOptionsKit& HPS::Exchange::ExportPRCOptionsKit::UnsetTessellationCompression

(

)

Removes the tessellation compression setting.

Returns

A reference to this ExportPRCOptionsKit.

Member Data Documentation

staticType

const HPS::Type HPS::Exchange::ExportPRCOptionsKit::staticType = HPS::Type::ExchangeExportPRCOptionsKit

static

---

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

• sprk_exchange.h