#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::ViewKit:
HPS::SprocketKit HPS::Sprocket HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (ViewKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (ViewKit const &in_kit) const
 
ViewKitoperator= (ViewKit const &in_kit)
 
ViewKitoperator= (ViewKit &&in_kit)
 
bool operator== (ViewKit const &in_kit) const
 
void Set (ViewKit const &in_kit)
 
ViewKitSetBackgroundColor (RGBColor const &in_color)
 
ViewKitSetCamera (CameraKit const &in_camera)
 
ViewKitSetDefault (bool in_state)
 
ViewKitSetExternalName (char const *in_name)
 
ViewKitSetInternalName (char const *in_name)
 
ViewKitSetLighting (Lighting::Mode in_mode)
 
ViewKitSetRendering (Rendering::Mode in_mode)
 
void Show (ViewKit &out_kit) const
 
bool ShowBackgroundColor (RGBColor &out_color) const
 
bool ShowCamera (CameraKit &out_camera) const
 
bool ShowDefault (bool &out_state) const
 
bool ShowExternalName (UTF8 &out_name) const
 
bool ShowInternalName (UTF8 &out_name) const
 
bool ShowLighting (Lighting::Mode &out_mode) const
 
bool ShowRendering (Rendering::Mode &out_mode) const
 
ViewKitUnsetBackgroundColor ()
 
ViewKitUnsetCamera ()
 
ViewKitUnsetDefault ()
 
ViewKitUnsetEverything ()
 
ViewKitUnsetExternalName ()
 
ViewKitUnsetInternalName ()
 
ViewKitUnsetLighting ()
 
ViewKitUnsetRendering ()
 
 ViewKit ()
 
 ViewKit (ViewKit const &in_kit)
 
 ViewKit (ViewKit &&in_kit)
 
- 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)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Member Functions

static ViewKit 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::PublishViewKit
 
- 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
SprocketKitoperator= (SprocketKit &&in_that)
 
 SprocketKit (SprocketKit &&in_that)
 

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_kitThe 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_kitAn rvalue reference to a ViewKit to take the underlying object from.

Member Function Documentation

◆ 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_kitThe source ViewKit to compare to this ViewKit.
Returns
true if the objects are equivalent, false otherwise.

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

◆ ObjectType()

HPS::Type HPS::Publish::ViewKit::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::Publish::ViewKit::operator!= ( ViewKit const &  in_kit) const

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

Parameters
in_kitThe 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_kitThe 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_kitAn 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_kitThe source ViewKit to compare to this ViewKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::Publish::ViewKit::Set ( ViewKit const &  in_kit)

Copies the source ViewKit into this ViewKit.

Parameters
in_kitThe 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_colorThe 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_cameraThe 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_stateWhether 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_nameUTF8-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_nameUTF8-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_modeThe 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_modeThe 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_kitThe 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_colorThe 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_cameraThe 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_stateWhether 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_nameThe 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_nameThe 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_modeThe 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_modeThe rendering mode for the view.
Returns
true if a rendering mode was specified, false otherwise.

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

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