HPS::Publish::ExportOptionsKit Class Reference

The ExportOptionsKit class is a user space object. More...

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::ExportOptionsKit:

Collaboration diagram for HPS::Publish::ExportOptionsKit:

Public Member Functions
	ExportOptionsKit ()
	The default constructor creates an empty ExportOptionsKit object. More...
	ExportOptionsKit (ExportOptionsKit const &in_kit)
	The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit. More...
	ExportOptionsKit (ExportOptionsKit &&in_kit)
	The move constructor creates an ExportOptionsKit by transferring the underlying object of the rvalue reference to this ExportOptionsKit. More...
virtual	~ExportOptionsKit ()
HPS::Type	ObjectType () const
void	Set (ExportOptionsKit const &in_kit)
	Copies the source ExportOptionsKit into this ExportOptionsKit. More...
void	Show (ExportOptionsKit &out_kit) const
	Copies this ExportOptionsKit into the given ExportOptionsKit. More...
ExportOptionsKit &	operator= (ExportOptionsKit const &in_kit)
	Copies the source ExportOptionsKit into this ExportOptionsKit. More...
ExportOptionsKit &	operator= (ExportOptionsKit &&in_kit)
	The move assignment operator transfers the underlying object of the rvalue reference to this ExportOptionsKit. More...
bool	Empty () const
	Indicates whether this ExportOptionsKit has any values set on it. More...
bool	Equals (ExportOptionsKit const &in_kit) const
	Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More...
bool	operator== (ExportOptionsKit const &in_kit) const
	Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More...
bool	operator!= (ExportOptionsKit const &in_kit) const
	Check if the source ExportOptionsKit is not equivalent to this ExportOptionsKit. More...
ExportOptionsKit &	SetDocumentToAppendTo (char const *in_filename)
	Sets the PDF document to append to. More...
ExportOptionsKit &	UnsetDocumentToAppendTo ()
	Removes the PDF document to append to setting. More...
ExportOptionsKit &	UnsetEverything ()
	Removes all data from the options kit. More...
bool	ShowDocumentToAppendTo (UTF8 &out_filename) const
	Shows the PDF document to append to 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
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

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

Detailed Description

The ExportOptionsKit class is a user space object.

It contains settings controlling how 3D PDF data is exported via Publish.

Constructor & Destructor Documentation

ExportOptionsKit() [1/3]

HPS::Publish::ExportOptionsKit::ExportOptionsKit

(

)

The default constructor creates an empty ExportOptionsKit object.

ExportOptionsKit() [2/3]

HPS::Publish::ExportOptionsKit::ExportOptionsKit

(

ExportOptionsKit const &

in_kit

)

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

Parameters

in_kit

The source ExportOptionsKit to copy.

ExportOptionsKit() [3/3]

HPS::Publish::ExportOptionsKit::ExportOptionsKit

(

ExportOptionsKit &&

in_kit

)

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

Parameters

in_kit

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

~ExportOptionsKit()

virtual HPS::Publish::ExportOptionsKit::~ExportOptionsKit ( )

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

virtual

Indicates whether this ExportOptionsKit has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::Publish::ExportOptionsKit::Equals

(

ExportOptionsKit const &

in_kit

)

const

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters

in_kit

The source ExportOptionsKit to compare to this ExportOptionsKit.

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.

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::Publish::ExportOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Publish::ExportOptionsKit::operator!=

(

ExportOptionsKit const &

in_kit

)

const

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

Parameters

in_kit

The source ExportOptionsKit to compare to this ExportOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

ExportOptionsKit& HPS::Publish::ExportOptionsKit::operator=

(

ExportOptionsKit const &

in_kit

)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters

in_kit

The source ExportOptionsKit to copy.

Returns

A reference to this ExportOptionsKit.

operator=() [2/2]

ExportOptionsKit& HPS::Publish::ExportOptionsKit::operator=

(

ExportOptionsKit &&

in_kit

)

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

Parameters

in_kit

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

Returns

A reference to this ExportOptionsKit.

operator==()

bool HPS::Publish::ExportOptionsKit::operator==

(

ExportOptionsKit const &

in_kit

)

const

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters

in_kit

The source ExportOptionsKit to compare to this ExportOptionsKit.

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::Publish::ExportOptionsKit::Set

(

ExportOptionsKit const &

in_kit

)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters

in_kit

The source ExportOptionsKit to copy.

SetDocumentToAppendTo()

ExportOptionsKit& HPS::Publish::ExportOptionsKit::SetDocumentToAppendTo

(

char const *

in_filename

)

Sets the PDF document to append to.

Parameters

in_filename

UTF8-encoded filename of the PDF document to append to.

Returns

A reference to this ExportOptionsKit.

Show()

void HPS::Publish::ExportOptionsKit::Show

(

ExportOptionsKit &

out_kit

)

const

Copies this ExportOptionsKit into the given ExportOptionsKit.

Parameters

out_kit

The ExportOptionsKit to populate with the contents of this ExportOptionsKit.

ShowDocumentToAppendTo()

bool HPS::Publish::ExportOptionsKit::ShowDocumentToAppendTo

(

UTF8 &

out_filename

)

const

Shows the PDF document to append to setting.

Parameters

out_filename

Filename of the PDF document to append to.

Returns

true if a PDF document to append to 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.

UnsetDocumentToAppendTo()

ExportOptionsKit& HPS::Publish::ExportOptionsKit::UnsetDocumentToAppendTo

(

)

Removes the PDF document to append to setting.

Returns

A reference to this ExportOptionsKit.

UnsetEverything()

ExportOptionsKit& HPS::Publish::ExportOptionsKit::UnsetEverything

(

)

Removes all data from the options kit.

Returns

A reference to this ExportOptionsKit.

Member Data Documentation

staticType

const HPS::Type HPS::Publish::ExportOptionsKit::staticType = HPS::Type::PublishExportOptionsKit

static

---

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

• sprk_publish.h