|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ ViewKit() [1/2]
HPS.Publish.ViewKit.ViewKit |
( |
| ) |
|
|
inline |
The default constructor creates an empty ViewKit object.
◆ ViewKit() [2/2]
The copy constructor creates a new ViewKit object that contains the same settings as the source ViewKit.
- Parameters
-
◆ Empty()
override bool HPS.Publish.ViewKit.Empty |
( |
| ) |
|
|
inlinevirtual |
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()
Check if the source ViewKit is equivalent to this ViewKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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.
◆ ObjectType()
override HPS.Type HPS.Publish.ViewKit.ObjectType |
( |
| ) |
|
|
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.
◆ Set()
◆ SetBackgroundColor()
◆ SetCamera()
◆ SetDefault()
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.
◆ SetExternalName()
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.
◆ SetInternalName()
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.
◆ SetLighting()
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.
◆ SetRendering()
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.
◆ Show()
◆ ShowBackgroundColor()
bool HPS.Publish.ViewKit.ShowBackgroundColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
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.
◆ ShowCamera()
bool HPS.Publish.ViewKit.ShowCamera |
( |
out HPS.CameraKit |
out_camera | ) |
|
|
inline |
Shows the camera setting.
- Parameters
-
out_camera | The camera for the view. |
- Returns
- true if a camera was specified, false otherwise.
◆ ShowDefault()
bool HPS.Publish.ViewKit.ShowDefault |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the default setting.
- Parameters
-
out_state | Whether this view is the default view. |
- Returns
- true if a default setting was specified, false otherwise.
◆ ShowExternalName()
bool HPS.Publish.ViewKit.ShowExternalName |
( |
out string |
out_name | ) |
|
|
inline |
Shows the external name setting.
- Parameters
-
out_name | The external name for the view. |
- Returns
- true if an external name was specified, false otherwise.
◆ ShowInternalName()
bool HPS.Publish.ViewKit.ShowInternalName |
( |
out string |
out_name | ) |
|
|
inline |
Shows the internal name setting.
- Parameters
-
out_name | The internal name for the view. |
- Returns
- true if an internal name was specified, false otherwise.
◆ ShowLighting()
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.
◆ ShowRendering()
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.
◆ UnsetBackgroundColor()
Removes the background color setting
- Returns
- A reference to this ViewKit.
◆ UnsetCamera()
Removes the camera setting.
- Returns
- A reference to this ViewKit.
◆ UnsetDefault()
Removes the default setting.
- Returns
- A reference to this ViewKit.
◆ UnsetEverything()
Removes all data from the view.
- Returns
- A reference to this ViewKit.
◆ UnsetExternalName()
Removes the external name setting.
- Returns
- A reference to this ViewKit.
◆ UnsetInternalName()
Removes the internal name setting.
- Returns
- A reference to this ViewKit.
◆ UnsetLighting()
Removes the lighting mode setting
- Returns
- A reference to this ViewKit.
◆ UnsetRendering()
Removes the rendering mode setting
- Returns
- A reference to this ViewKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs