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
- override bool Empty ()
Indicates whether this ViewKit has any values set on it.
- Return
true if no values are set on this ViewKit, false otherwise.
- bool Equals (HPS.Publish.ViewKit in_kit)
- override HPS.Type ObjectType ()
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).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- void Set (HPS.Publish.ViewKit in_kit)
Copies the source ViewKit into this ViewKit.
- Param in_kit
The source ViewKit to copy.
- HPS.Publish.ViewKit SetBackgroundColor (HPS.RGBColor in_color)
Sets the background color for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_sViewBackgroundColor.
- Param in_color
The background color for the view.
- Return
A reference to this ViewKit.
- HPS.Publish.ViewKit SetCamera (HPS.CameraKit 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.
- Param in_camera
The camera for the view.
- Return
A reference to this 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.
- Param in_state
Whether this view is the default view.
- Return
A reference to this ViewKit.
- HPS.Publish.ViewKit SetExternalName (string in_name)
Sets the external name for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_pcExternalName.
- Param in_name
UTF8-encoded external name for the view.
- Return
A reference to this ViewKit.
- HPS.Publish.ViewKit SetInternalName (string in_name)
Sets the internal name for the view.
- Param in_name
UTF8-encoded internal name for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_pcInternalName.
- Return
A reference to this ViewKit.
- HPS.Publish.ViewKit SetLighting (HPS.Publish.Lighting.Mode in_mode)
Sets the lighting mode for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_eViewLighting.
- Param in_mode
The lighting mode for the view.
- Return
A reference to this ViewKit.
- HPS.Publish.ViewKit SetRendering (HPS.Publish.Rendering.Mode in_mode)
Sets the rendering mode for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_eRenderingStyle.
- Param in_mode
The rendering mode for the view.
- Return
A reference to this ViewKit.
- void Show (out HPS.Publish.ViewKit out_kit)
- bool ShowBackgroundColor (out HPS.RGBColor out_color)
Shows the background color for the view.
- Param out_color
The background color for the view.
- Return
true if a background color was specified, false otherwise.
- bool ShowCamera (out HPS.CameraKit out_camera)
Shows the camera setting.
- Param out_camera
The camera for the view.
- Return
true if a camera was specified, false otherwise.
- bool ShowDefault (out bool out_state)
Shows the default setting.
- Param out_state
Whether this view is the default view.
- Return
true if a default setting was specified, false otherwise.
- bool ShowExternalName (out string out_name)
Shows the external name setting.
- Param out_name
The external name for the view.
- Return
true if an external name was specified, false otherwise.
- bool ShowInternalName (out string out_name)
Shows the internal name setting.
- Param out_name
The internal name for the view.
- Return
true if an internal name was specified, false otherwise.
- bool ShowLighting (out HPS.Publish.Lighting.Mode out_mode)
Shows the lighting mode for the view.
- Param out_mode
The lighting mode for the view.
- Return
true if a lighting mode was specified, false otherwise.
- bool ShowRendering (out HPS.Publish.Rendering.Mode out_mode)
Shows the rendering mode for the view.
- Param out_mode
The rendering mode for the view.
- Return
true if a rendering mode was specified, false otherwise.
- HPS.Publish.ViewKit UnsetBackgroundColor ()
Removes the background color setting
- Return
A reference to this ViewKit.
- HPS.Publish.ViewKit UnsetCamera ()
Removes the camera setting.
- Return
A reference to this ViewKit.
- HPS.Publish.ViewKit UnsetDefault ()
Removes the default setting.
- Return
A reference to this ViewKit.
- HPS.Publish.ViewKit UnsetEverything ()
Removes all data from the view.
- Return
A reference to this ViewKit.
- HPS.Publish.ViewKit UnsetExternalName ()
Removes the external name setting.
- Return
A reference to this ViewKit.
- HPS.Publish.ViewKit UnsetInternalName ()
Removes the internal name setting.
- Return
A reference to this ViewKit.
- HPS.Publish.ViewKit UnsetLighting ()
Removes the lighting mode setting
- Return
A reference to this ViewKit.
- HPS.Publish.ViewKit UnsetRendering ()
Removes the rendering mode setting
- Return
A reference to this ViewKit.
- ViewKit (HPS.Publish.ViewKit in_kit)
The copy constructor creates a new ViewKit object that contains the same settings as the source ViewKit.
- Param in_kit
The source ViewKit to copy.
Public Static Functions
- HPS.Publish.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.
- Return
A ViewKit with the default settings.
