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. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ViewKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.ViewKit in_kit) |
Check if the source ViewKit is equivalent to this ViewKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.Publish.ViewKit in_kit) |
Copies the source ViewKit into this ViewKit. More... | |
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a42b3a961b62e86668dd6d40462e8c603">A3DPDFViewData::m_sViewBackgroundColor</ulink>. More... | |
HPS.Publish.ViewKit | SetCamera (HPS.CameraKit in_camera) |
Sets the camera for the view. This corresponds to the values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a9f79bebe0e2d6ac6d29fc253d1414b4f">A3DPDFViewData::m_sPosition</ulink>, <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#aa29602b2ea96c0ce793040deb2ba8fc5">A3DPDFViewData::m_sTarget</ulink>, <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a18bf7ccfc0451bf52b1cee32dbceab9b">A3DPDFViewData::m_sUpVector</ulink>, <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a00eae0ff4d0f145787406c729dc83c4b">A3DPDFViewData::m_dZoomFactor</ulink>, <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a472edf22d468eeb5e834b5fea777d75c">A3DPDFViewData::m_eProjectionMode</ulink>, and <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#aa7056b8577c01d37bc5e9af4e008011a">A3DPDFViewData::m_dFieldOfView</ulink>. More... | |
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a4d03a8c18f745487873eb3090da55537">A3DPDFViewData::m_bIsDefault</ulink>. More... | |
HPS.Publish.ViewKit | SetExternalName (string in_name) |
Sets the external name for the view. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a3accdda36cd587f78f3e7ff3d85b9893">A3DPDFViewData::m_pcExternalName</ulink>. More... | |
HPS.Publish.ViewKit | SetInternalName (string in_name) |
Sets the internal name for the view. More... | |
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a1f60c93ea54c67cb0690bcd4bd2e9c89">A3DPDFViewData::m_eViewLighting</ulink>. More... | |
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a0003ea03bb292482032038a017eebb8a">A3DPDFViewData::m_eRenderingStyle</ulink>. More... | |
void | Show (out HPS.Publish.ViewKit out_kit) |
Copies this ViewKit into the given ViewKit. More... | |
bool | ShowBackgroundColor (out HPS.RGBColor out_color) |
Shows the background color for the view. More... | |
bool | ShowCamera (out HPS.CameraKit out_camera) |
Shows the camera setting. More... | |
bool | ShowDefault (out bool out_state) |
Shows the default setting. More... | |
bool | ShowExternalName (out string out_name) |
Shows the external name setting. More... | |
bool | ShowInternalName (out string out_name) |
Shows the internal name setting. More... | |
bool | ShowLighting (out HPS.Publish.Lighting.Mode out_mode) |
Shows the lighting mode for the view. More... | |
bool | ShowRendering (out HPS.Publish.Rendering.Mode out_mode) |
Shows the rendering mode for the view. More... | |
HPS.Publish.ViewKit | UnsetBackgroundColor () |
Removes the background color setting More... | |
HPS.Publish.ViewKit | UnsetCamera () |
Removes the camera setting. More... | |
HPS.Publish.ViewKit | UnsetDefault () |
Removes the default setting. More... | |
HPS.Publish.ViewKit | UnsetEverything () |
Removes all data from the view. More... | |
HPS.Publish.ViewKit | UnsetExternalName () |
Removes the external name setting. More... | |
HPS.Publish.ViewKit | UnsetInternalName () |
Removes the internal name setting. More... | |
HPS.Publish.ViewKit | UnsetLighting () |
Removes the lighting mode setting More... | |
HPS.Publish.ViewKit | UnsetRendering () |
Removes the rendering mode setting More... | |
ViewKit () | |
The default constructor creates an empty ViewKit object. More... | |
ViewKit (HPS.Publish.ViewKit in_kit) | |
The copy constructor creates a new ViewKit object that contains the same settings as the source ViewKit. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static 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. More... | |
static bool | operator!= (HPS.Publish.ViewKit a, HPS.Publish.ViewKit b) |
static bool | operator== (HPS.Publish.ViewKit a, HPS.Publish.ViewKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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.
|
inline |
The default constructor creates an empty ViewKit object.
|
inline |
|
inlinevirtual |
Indicates whether this ViewKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
|
inlinestatic |
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 HPS.Object.
|
inline |
|
inline |
Sets the background color for the view. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a42b3a961b62e86668dd6d40462e8c603">A3DPDFViewData::m_sViewBackgroundColor</ulink>.
in_color | The background color for the view. |
|
inline |
Sets the camera for the view. This corresponds to the values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a9f79bebe0e2d6ac6d29fc253d1414b4f">A3DPDFViewData::m_sPosition</ulink>, <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#aa29602b2ea96c0ce793040deb2ba8fc5">A3DPDFViewData::m_sTarget</ulink>, <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a18bf7ccfc0451bf52b1cee32dbceab9b">A3DPDFViewData::m_sUpVector</ulink>, <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a00eae0ff4d0f145787406c729dc83c4b">A3DPDFViewData::m_dZoomFactor</ulink>, <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a472edf22d468eeb5e834b5fea777d75c">A3DPDFViewData::m_eProjectionMode</ulink>, and <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#aa7056b8577c01d37bc5e9af4e008011a">A3DPDFViewData::m_dFieldOfView</ulink>.
in_camera | The camera for the view. |
|
inline |
Sets whether this view is the default view. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a4d03a8c18f745487873eb3090da55537">A3DPDFViewData::m_bIsDefault</ulink>.
in_state | Whether this view is the default view. |
|
inline |
Sets the external name for the view. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a3accdda36cd587f78f3e7ff3d85b9893">A3DPDFViewData::m_pcExternalName</ulink>.
in_name | UTF8-encoded external name for the view. |
|
inline |
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. |
|
inline |
Sets the lighting mode for the view. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a1f60c93ea54c67cb0690bcd4bd2e9c89">A3DPDFViewData::m_eViewLighting</ulink>.
in_mode | The lighting mode for the view. |
|
inline |
Sets the rendering mode for the view. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_view_data.html#a0003ea03bb292482032038a017eebb8a">A3DPDFViewData::m_eRenderingStyle</ulink>.
in_mode | The rendering mode for the view. |
|
inline |
|
inline |
Shows the background color for the view.
out_color | The background color for the view. |
|
inline |
Shows the camera setting.
out_camera | The camera for the view. |
|
inline |
Shows the default setting.
out_state | Whether this view is the default view. |
|
inline |
Shows the external name setting.
out_name | The external name for the view. |
|
inline |
Shows the internal name setting.
out_name | The internal name for the view. |
|
inline |
Shows the lighting mode for the view.
out_mode | The lighting mode for the view. |
|
inline |
Shows the rendering mode for the view.
out_mode | The rendering mode for the view. |
|
inline |
Removes the background color setting
|
inline |
Removes the camera setting.
|
inline |
Removes the default setting.
|
inline |
Removes all data from the view.
|
inline |
Removes the external name setting.
|
inline |
Removes the internal name setting.
|
inline |
Removes the lighting mode setting
|
inline |
Removes the rendering mode setting