#include <sprk_publish.h>
|
enum | UpdateType { Synchronous,
Asynchronous
} |
|
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.
HPS::Publish::ViewKit::ViewKit |
( |
| ) |
|
The default constructor creates an empty ViewKit object.
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
-
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. |
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.
bool HPS::Publish::ViewKit::Equals |
( |
ViewKit const & |
in_kit | ) |
const |
Check if the source ViewKit is equivalent to this ViewKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
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.
HPS::Type HPS::Publish::ViewKit::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
bool HPS::Publish::ViewKit::operator!= |
( |
ViewKit const & |
in_kit | ) |
const |
Check if the source ViewKit is not equivalent to this ViewKit.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
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.
bool HPS::Publish::ViewKit::operator== |
( |
ViewKit const & |
in_kit | ) |
const |
Check if the source ViewKit is equivalent to this ViewKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::Publish::ViewKit::Set |
( |
ViewKit const & |
in_kit | ) |
|
ViewKit& HPS::Publish::ViewKit::SetBackgroundColor |
( |
RGBColor const & |
in_color | ) |
|
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.
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.
ViewKit& HPS::Publish::ViewKit::SetInternalName |
( |
char const * |
in_name | ) |
|
Sets the internal name for the view.
- Parameters
-
- Returns
- A reference to this ViewKit.
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.
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 HPS::Publish::ViewKit::Show |
( |
ViewKit & |
out_kit | ) |
const |
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.
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.
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.
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.
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.
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.
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.
ViewKit& HPS::Publish::ViewKit::UnsetBackgroundColor |
( |
| ) |
|
Removes the background color setting
- Returns
- A reference to this ViewKit.
ViewKit& HPS::Publish::ViewKit::UnsetCamera |
( |
| ) |
|
Removes the camera setting.
- Returns
- A reference to this ViewKit.
ViewKit& HPS::Publish::ViewKit::UnsetDefault |
( |
| ) |
|
Removes the default setting.
- Returns
- A reference to this ViewKit.
ViewKit& HPS::Publish::ViewKit::UnsetEverything |
( |
| ) |
|
Removes all data from the view.
- Returns
- A reference to this ViewKit.
ViewKit& HPS::Publish::ViewKit::UnsetExternalName |
( |
| ) |
|
Removes the external name setting.
- Returns
- A reference to this ViewKit.
ViewKit& HPS::Publish::ViewKit::UnsetInternalName |
( |
| ) |
|
Removes the internal name setting.
- Returns
- A reference to this ViewKit.
ViewKit& HPS::Publish::ViewKit::UnsetLighting |
( |
| ) |
|
Removes the lighting mode setting
- Returns
- A reference to this ViewKit.
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: