HPS::Publish::ViewKit Class Reference

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

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::ViewKit:

Collaboration diagram for HPS::Publish::ViewKit:

Public Member Functions
	ViewKit ()
	The default constructor creates an empty ViewKit object. More...
	ViewKit (ViewKit const &in_kit)
	The copy constructor creates a new ViewKit object that contains the same settings as the source ViewKit. More...
	ViewKit (ViewKit &&in_kit)
	The move constructor creates a ViewKit by transferring the underlying object of the rvalue reference to this ViewKit. More...
virtual	~ViewKit ()
HPS::Type	ObjectType () const
void	Set (ViewKit const &in_kit)
	Copies the source ViewKit into this ViewKit. More...
void	Show (ViewKit &out_kit) const
	Copies this ViewKit into the given ViewKit. More...
ViewKit &	operator= (ViewKit const &in_kit)
	Copies the source ViewKit into this ViewKit. More...
ViewKit &	operator= (ViewKit &&in_kit)
	The move assignment operator transfers the underlying object of the rvalue reference to this ViewKit. More...
bool	Empty () const
	Indicates whether this ViewKit has any values set on it. More...
bool	Equals (ViewKit const &in_kit) const
	Check if the source ViewKit is equivalent to this ViewKit. More...
bool	operator== (ViewKit const &in_kit) const
	Check if the source ViewKit is equivalent to this ViewKit. More...
bool	operator!= (ViewKit const &in_kit) const
	Check if the source ViewKit is not equivalent to this ViewKit. More...
ViewKit &	SetInternalName (char const *in_name)
	Sets the internal name for the view. More...
ViewKit &	SetExternalName (char const *in_name)
	Sets the external name for the view. More...
ViewKit &	SetCamera (CameraKit const &in_camera)
	Sets the camera for the view. More...
ViewKit &	SetDefault (bool in_state)
	Sets whether this view is the default view. More...
ViewKit &	SetBackgroundColor (RGBColor const &in_color)
	Sets the background color for the view. More...
ViewKit &	SetLighting (Lighting::Mode in_mode)
	Sets the lighting mode for the view. More...
ViewKit &	SetRendering (Rendering::Mode in_mode)
	Sets the rendering mode for the view. More...
ViewKit &	UnsetInternalName ()
	Removes the internal name setting. More...
ViewKit &	UnsetExternalName ()
	Removes the external name setting. More...
ViewKit &	UnsetCamera ()
	Removes the camera setting. More...
ViewKit &	UnsetDefault ()
	Removes the default setting. More...
ViewKit &	UnsetBackgroundColor ()
	Removes the background color setting. More...
ViewKit &	UnsetLighting ()
	Removes the lighting mode setting. More...
ViewKit &	UnsetRendering ()
	Removes the rendering mode setting. More...
ViewKit &	UnsetEverything ()
	Removes all data from the view. More...
bool	ShowInternalName (UTF8 &out_name) const
	Shows the internal name setting. More...
bool	ShowExternalName (UTF8 &out_name) const
	Shows the external name setting. More...
bool	ShowCamera (CameraKit &out_camera) const
	Shows the camera setting. More...
bool	ShowDefault (bool &out_state) const
	Shows the default setting. More...
bool	ShowBackgroundColor (RGBColor &out_color) const
	Shows the background color for the view. More...
bool	ShowLighting (Lighting::Mode &out_mode) const
	Shows the lighting mode for the view. More...
bool	ShowRendering (Rendering::Mode &out_mode) const
	Shows the rendering mode for the view. 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 ViewKit	GetDefault ()
	Creates a ViewKit 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::PublishViewKit

Detailed Description

The ViewKit class is a user space object.

It acts as the container for all data that can be set on a view in a Publish PDF.

Constructor & Destructor Documentation

ViewKit() [1/3]

HPS::Publish::ViewKit::ViewKit

(

)

The default constructor creates an empty ViewKit object.

ViewKit() [2/3]

HPS::Publish::ViewKit::ViewKit

(

ViewKit const &

in_kit

)

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

Parameters

in_kit

The source ViewKit to copy.

ViewKit() [3/3]

HPS::Publish::ViewKit::ViewKit

(

ViewKit &&

in_kit

)

The move constructor creates a ViewKit by transferring the underlying object of the rvalue reference to this ViewKit.

Parameters

in_kit

An rvalue reference to a ViewKit to take the underlying object from.

~ViewKit()

virtual HPS::Publish::ViewKit::~ViewKit ( )

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

virtual

Indicates whether this ViewKit has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::Publish::ViewKit::Equals

(

ViewKit const &

in_kit

)

const

Check if the source ViewKit is equivalent to this ViewKit.

Parameters

in_kit

The source ViewKit to compare to this ViewKit.

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 ViewKit HPS::Publish::ViewKit::GetDefault ( )

static

Creates a ViewKit which contains the default settings.

The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for export unless a setting is overridden by the ViewKit passed to File::Export.

Returns

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

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Publish::ViewKit::operator!=

(

ViewKit const &

in_kit

)

const

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

Parameters

in_kit

The source ViewKit to compare to this ViewKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

ViewKit& HPS::Publish::ViewKit::operator=

(

ViewKit const &

in_kit

)

Copies the source ViewKit into this ViewKit.

Parameters

in_kit

The source ViewKit to copy.

Returns

A reference to this ViewKit.

operator=() [2/2]

ViewKit& HPS::Publish::ViewKit::operator=

(

ViewKit &&

in_kit

)

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

Parameters

in_kit

An rvalue reference to a ViewKit to take the underlying object from.

Returns

A reference to this ViewKit.

operator==()

bool HPS::Publish::ViewKit::operator==

(

ViewKit const &

in_kit

)

const

Check if the source ViewKit is equivalent to this ViewKit.

Parameters

in_kit

The source ViewKit to compare to this ViewKit.

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

(

ViewKit const &

in_kit

)

Copies the source ViewKit into this ViewKit.

Parameters

in_kit

The source ViewKit to copy.

SetBackgroundColor()

ViewKit& HPS::Publish::ViewKit::SetBackgroundColor

(

RGBColor const &

in_color

)

Sets the background color for the view.

This corresponds to the value that will be passed to A3DPDFViewData::m_sViewBackgroundColor.

Parameters

in_color

The background color for the view.

Returns

A reference to this ViewKit.

SetCamera()

ViewKit& HPS::Publish::ViewKit::SetCamera

(

CameraKit const &

in_camera

)

Sets the camera for the view.

This corresponds to the values that will be passed to A3DPDFViewData::m_sPosition, A3DPDFViewData::m_sTarget, A3DPDFViewData::m_sUpVector, A3DPDFViewData::m_dZoomFactor, A3DPDFViewData::m_eProjectionMode, and A3DPDFViewData::m_dFieldOfView.

Parameters

in_camera

The camera for the view.

Returns

A reference to this ViewKit.

SetDefault()

ViewKit& HPS::Publish::ViewKit::SetDefault

(

bool

in_state

)

Sets whether this view is the default view.

This corresponds to the value that will be passed to A3DPDFViewData::m_bIsDefault.

Parameters

in_state

Whether this view is the default view.

Returns

A reference to this ViewKit.

SetExternalName()

ViewKit& HPS::Publish::ViewKit::SetExternalName

(

char const *

in_name

)

Sets the external name for the view.

This corresponds to the value that will be passed to A3DPDFViewData::m_pcExternalName.

Parameters

in_name

UTF8-encoded external name for the view.

Returns

A reference to this ViewKit.

SetInternalName()

ViewKit& HPS::Publish::ViewKit::SetInternalName

(

char const *

in_name

)

Sets the internal name for the view.

Parameters

in_name

UTF8-encoded internal name for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_pcInternalName.

Returns

A reference to this ViewKit.

SetLighting()

ViewKit& HPS::Publish::ViewKit::SetLighting

(

Lighting::Mode

in_mode

)

Sets the lighting mode for the view.

This corresponds to the value that will be passed to A3DPDFViewData::m_eViewLighting.

Parameters

in_mode

The lighting mode for the view.

Returns

A reference to this ViewKit.

SetRendering()

ViewKit& HPS::Publish::ViewKit::SetRendering

(

Rendering::Mode

in_mode

)

Sets the rendering mode for the view.

This corresponds to the value that will be passed to A3DPDFViewData::m_eRenderingStyle.

Parameters

in_mode

The rendering mode for the view.

Returns

A reference to this ViewKit.

Show()

void HPS::Publish::ViewKit::Show

(

ViewKit &

out_kit

)

const

Copies this ViewKit into the given ViewKit.

Parameters

out_kit

The ViewKit to populate with the contents of this ViewKit.

ShowBackgroundColor()

bool HPS::Publish::ViewKit::ShowBackgroundColor

(

RGBColor &

out_color

)

const

Shows the background color for the view.

Parameters

out_color

The background color for the view.

Returns

true if a background color was specified, false otherwise.

ShowCamera()

bool HPS::Publish::ViewKit::ShowCamera

(

CameraKit &

out_camera

)

const

Shows the camera setting.

Parameters

out_camera

The camera for the view.

Returns

true if a camera was specified, false otherwise.

ShowDefault()

bool HPS::Publish::ViewKit::ShowDefault

(

bool &

out_state

)

const

Shows the default setting.

Parameters

out_state

Whether this view is the default view.

Returns

true if a default setting was specified, false otherwise.

ShowExternalName()

bool HPS::Publish::ViewKit::ShowExternalName

(

UTF8 &

out_name

)

const

Shows the external name setting.

Parameters

out_name

The external name for the view.

Returns

true if an external name was specified, false otherwise.

ShowInternalName()

bool HPS::Publish::ViewKit::ShowInternalName

(

UTF8 &

out_name

)

const

Shows the internal name setting.

Parameters

out_name

The internal name for the view.

Returns

true if an internal name was specified, false otherwise.

ShowLighting()

bool HPS::Publish::ViewKit::ShowLighting

(

Lighting::Mode &

out_mode

)

const

Shows the lighting mode for the view.

Parameters

out_mode

The lighting mode for the view.

Returns

true if a lighting mode was specified, false otherwise.

ShowRendering()

bool HPS::Publish::ViewKit::ShowRendering

(

Rendering::Mode &

out_mode

)

const

Shows the rendering mode for the view.

Parameters

out_mode

The rendering mode for the view.

Returns

true if a rendering mode 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.

UnsetBackgroundColor()

ViewKit& HPS::Publish::ViewKit::UnsetBackgroundColor

(

)

Removes the background color setting.

Returns

A reference to this ViewKit.

UnsetCamera()

ViewKit& HPS::Publish::ViewKit::UnsetCamera

(

)

Removes the camera setting.

Returns

A reference to this ViewKit.

UnsetDefault()

ViewKit& HPS::Publish::ViewKit::UnsetDefault

(

)

Removes the default setting.

Returns

A reference to this ViewKit.

UnsetEverything()

ViewKit& HPS::Publish::ViewKit::UnsetEverything

(

)

Removes all data from the view.

Returns

A reference to this ViewKit.

UnsetExternalName()

ViewKit& HPS::Publish::ViewKit::UnsetExternalName

(

)

Removes the external name setting.

Returns

A reference to this ViewKit.

UnsetInternalName()

ViewKit& HPS::Publish::ViewKit::UnsetInternalName

(

)

Removes the internal name setting.

Returns

A reference to this ViewKit.

UnsetLighting()

ViewKit& HPS::Publish::ViewKit::UnsetLighting

(

)

Removes the lighting mode setting.

Returns

A reference to this ViewKit.

UnsetRendering()

ViewKit& HPS::Publish::ViewKit::UnsetRendering

(

)

Removes the rendering mode setting.

Returns

A reference to this ViewKit.

Member Data Documentation

staticType

const HPS::Type HPS::Publish::ViewKit::staticType = HPS::Type::PublishViewKit

static

---

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

• sprk_publish.h