REFERENCE MANUAL
#include <sprk_publish.h>
Public Member Functions | |
bool | Empty () const |
bool | Equals (ViewKit const &in_kit) const |
Type | ObjectType () const |
bool | operator!= (ViewKit const &in_kit) const |
ViewKit & | operator= (ViewKit const &in_kit) |
ViewKit & | operator= (ViewKit &&in_kit) |
bool | operator== (ViewKit const &in_kit) const |
void | Set (ViewKit const &in_kit) |
ViewKit & | SetBackgroundColor (RGBColor const &in_color) |
ViewKit & | SetCamera (CameraKit const &in_camera) |
ViewKit & | SetDefault (bool in_state) |
ViewKit & | SetExternalName (char const *in_name) |
ViewKit & | SetInternalName (char const *in_name) |
ViewKit & | SetLighting (Lighting::Mode in_mode) |
ViewKit & | SetRendering (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 |
ViewKit & | UnsetBackgroundColor () |
ViewKit & | UnsetCamera () |
ViewKit & | UnsetDefault () |
ViewKit & | UnsetEverything () |
ViewKit & | UnsetExternalName () |
ViewKit & | UnsetInternalName () |
ViewKit & | UnsetLighting () |
ViewKit & | UnsetRendering () |
ViewKit () | |
ViewKit (ViewKit const &in_kit) | |
ViewKit (ViewKit &&in_kit) | |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Static Public Member Functions | |
static ViewKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
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.
Publish::ViewKit::ViewKit | ( | ) |
The default constructor creates an empty ViewKit object.
Publish::ViewKit::ViewKit | ( | ViewKit const & | in_kit | ) |
Publish::ViewKit::ViewKit | ( | ViewKit && | in_kit | ) |
|
virtual |
bool Publish::ViewKit::Equals | ( | ViewKit const & | in_kit | ) | const |
|
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool Publish::ViewKit::operator!= | ( | ViewKit const & | in_kit | ) | const |
bool Publish::ViewKit::operator== | ( | ViewKit const & | in_kit | ) | const |
void Publish::ViewKit::Set | ( | ViewKit const & | in_kit | ) |
Sets the background color for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_sViewBackgroundColor.
in_color | The background color for the view. |
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.
in_camera | The camera for the view. |
ViewKit& 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.
in_state | Whether this view is the default view. |
ViewKit& 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.
in_name | UTF8-encoded external name for the view. |
ViewKit& Publish::ViewKit::SetInternalName | ( | char const * | in_name | ) |
Sets the internal name for the view.
in_name | UTF8-encoded internal name for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_pcInternalName. |
ViewKit& 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.
in_mode | The lighting mode for the view. |
ViewKit& 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.
in_mode | The rendering mode for the view. |
void Publish::ViewKit::Show | ( | ViewKit & | out_kit | ) | const |
bool Publish::ViewKit::ShowBackgroundColor | ( | RGBColor & | out_color | ) | const |
Shows the background color for the view.
out_color | The background color for the view. |
bool Publish::ViewKit::ShowCamera | ( | CameraKit & | out_camera | ) | const |
Shows the camera setting.
out_camera | The camera for the view. |
bool Publish::ViewKit::ShowDefault | ( | bool & | out_state | ) | const |
Shows the default setting.
out_state | Whether this view is the default view. |
bool Publish::ViewKit::ShowExternalName | ( | UTF8 & | out_name | ) | const |
Shows the external name setting.
out_name | The external name for the view. |
bool Publish::ViewKit::ShowInternalName | ( | UTF8 & | out_name | ) | const |
Shows the internal name setting.
out_name | The internal name for the view. |
bool Publish::ViewKit::ShowLighting | ( | Lighting::Mode & | out_mode | ) | const |
Shows the lighting mode for the view.
out_mode | The lighting mode for the view. |
bool Publish::ViewKit::ShowRendering | ( | Rendering::Mode & | out_mode | ) | const |
Shows the rendering mode for the view.
out_mode | The rendering mode for the view. |
ViewKit& Publish::ViewKit::UnsetBackgroundColor | ( | ) |
Removes the background color setting
ViewKit& Publish::ViewKit::UnsetCamera | ( | ) |
Removes the camera setting.
ViewKit& Publish::ViewKit::UnsetDefault | ( | ) |
Removes the default setting.
ViewKit& Publish::ViewKit::UnsetEverything | ( | ) |
Removes all data from the view.
ViewKit& Publish::ViewKit::UnsetExternalName | ( | ) |
Removes the external name setting.
ViewKit& Publish::ViewKit::UnsetInternalName | ( | ) |
Removes the internal name setting.
ViewKit& Publish::ViewKit::UnsetLighting | ( | ) |
Removes the lighting mode setting
ViewKit& Publish::ViewKit::UnsetRendering | ( | ) |
Removes the rendering mode setting