#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ExportPRCOptionsKit:

Public Member Functions
bool	Empty () const

bool	Equals (ExportPRCOptionsKit const &in_kit) const

	ExportPRCOptionsKit ()

	ExportPRCOptionsKit (ExportPRCOptionsKit const &in_kit)

	ExportPRCOptionsKit (ExportPRCOptionsKit &&in_that)

HPS::Type	ObjectType () const

bool	operator!= (ExportPRCOptionsKit const &in_kit) const

ExportPRCOptionsKit &	operator= (ExportPRCOptionsKit const &in_kit)

ExportPRCOptionsKit &	operator= (ExportPRCOptionsKit &&in_that)

bool	operator== (ExportPRCOptionsKit const &in_kit) const

void	Set (ExportPRCOptionsKit const &in_kit)

ExportPRCOptionsKit &	SetAdditionalKeyPaths (KeyPathArray const &in_additional_key_paths)

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

ExportPRCOptionsKit &	SetAttributeRemoval (bool in_state)

ExportPRCOptionsKit &	SetBRepCompression (PRC::BRepCompression in_level)

ExportPRCOptionsKit &	SetBRepRemoval (bool in_state)

ExportPRCOptionsKit &	SetTessellationCompression (bool in_state)

void	Show (ExportPRCOptionsKit &out_kit) const

bool	ShowAdditionalKeyPaths (KeyPathArray &out_additional_key_paths) const

bool	ShowAttributeRemoval (bool &out_state) const

bool	ShowBRepCompression (PRC::BRepCompression &out_level) const

bool	ShowBRepRemoval (bool &out_state) const

bool	ShowTessellationCompression (bool &out_state) const

ExportPRCOptionsKit &	UnsetAdditionalKeyPaths ()

ExportPRCOptionsKit &	UnsetAttributeRemoval ()

ExportPRCOptionsKit &	UnsetBRepCompression ()

ExportPRCOptionsKit &	UnsetBRepRemoval ()

ExportPRCOptionsKit &	UnsetEverything ()

ExportPRCOptionsKit &	UnsetTessellationCompression ()

Public Member Functions inherited from HPS::Sprocket
	Sprocket (Sprocket &&in_that)

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)

Object &	operator= (Object const &other_object)

Object &	operator= (Object &&in_that)

virtual void	Reset ()

virtual HPS::Type	Type () const

Static Public Member Functions
static ExportPRCOptionsKit	GetDefault ()

Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t	ClassID ()

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

Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type	staticType = HPS::Type::SprocketKit

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

Additional Inherited Members
Protected Member Functions inherited from HPS::SprocketKit
SprocketKit &	operator= (SprocketKit &&in_that)

	SprocketKit (SprocketKit &&in_that)

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.

Member Function Documentation

◆ 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.

◆ 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.

◆ ObjectType()

HPS::Type HPS::Exchange::ExportPRCOptionsKit::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::SprocketKit.

◆ 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.

◆ 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.

◆ 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.

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

include/sprk_exchange.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExportPRCOptionsKit() [1/3]

◆ ExportPRCOptionsKit() [2/3]

◆ ExportPRCOptionsKit() [3/3]

Member Function Documentation

◆ Empty()

◆ Equals()

◆ GetDefault()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Set()

◆ SetAdditionalKeyPaths() [1/2]

◆ SetAdditionalKeyPaths() [2/2]

◆ SetAttributeRemoval()

◆ SetBRepCompression()

◆ SetBRepRemoval()

◆ SetTessellationCompression()

◆ Show()

◆ ShowAdditionalKeyPaths()

◆ ShowAttributeRemoval()

◆ ShowBRepCompression()

◆ ShowBRepRemoval()

◆ ShowTessellationCompression()

◆ UnsetAdditionalKeyPaths()

◆ UnsetAttributeRemoval()

◆ UnsetBRepCompression()

◆ UnsetBRepRemoval()

◆ UnsetEverything()

◆ UnsetTessellationCompression()