HPS::Publish::ViewKit
-
class HPS::Publish::ViewKit : public HPS::SprocketKit
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.
Public Functions
-
virtual bool Empty() const
Indicates whether this ViewKit has any values set on it.
- Returns
true if no values are set on this ViewKit, false otherwise.
-
bool Equals(ViewKit const &in_kit) const
-
inline virtual HPS::Type ObjectType() const
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.
-
bool operator!=(ViewKit const &in_kit) const
Check if the source ViewKit is not equivalent to this ViewKit.
-
ViewKit &operator=(ViewKit &&in_kit)
The move assignment operator transfers the underlying object of the rvalue reference to this ViewKit.
-
bool operator==(ViewKit const &in_kit) const
-
void Set(ViewKit const &in_kit)
Copies the source ViewKit into this ViewKit.
- Parameters
in_kit – The source ViewKit to copy.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
void Show(ViewKit &out_kit) const
-
bool 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.
-
bool 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.
-
bool 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.
-
bool 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.
-
bool 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.
-
bool 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.
-
bool 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.
-
ViewKit &UnsetBackgroundColor()
Removes the background color setting
- Returns
A reference to this ViewKit.
-
ViewKit &UnsetExternalName()
Removes the external name setting.
- Returns
A reference to this ViewKit.
-
ViewKit &UnsetInternalName()
Removes the internal name setting.
- Returns
A reference to this ViewKit.
-
ViewKit()
The default constructor creates an empty ViewKit object.
-
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(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.
-
virtual ~ViewKit()
Public Static Functions
-
static ViewKit GetDefault()
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.
Public Static Attributes
-
static const HPS::Type staticType = HPS::Type::PublishViewKit
-
virtual bool Empty() const
