< Home

< Table of Contents

REFERENCE MANUAL

HPS.Publish.ViewKit Class Reference

The ViewKit class is a user space object. More...

Inheritance diagram for HPS.Publish.ViewKit:
HPS.Sprocket HPS.Object

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. 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. More...
 
HPS.Publish.ViewKit SetCamera (HPS.CameraKit in_camera)
 Sets the camera for the view. More...
 
HPS.Publish.ViewKit SetDefault (bool in_state)
 Sets whether this view is the default view. More...
 
HPS.Publish.ViewKit SetExternalName (string in_name)
 Sets the external name for the view. 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. More...
 
HPS.Publish.ViewKit SetRendering (HPS.Publish.Rendering.Mode in_mode)
 Sets the rendering mode for the view. 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...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
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. More...
 

Static Public Member Functions

static HPS.Publish.ViewKit GetDefault ()
 Creates a ViewKit which contains the default settings. More...
 
static bool operator!= (HPS.Publish.ViewKit a, HPS.Publish.ViewKit b)
 
static bool operator== (HPS.Publish.ViewKit a, HPS.Publish.ViewKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

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.

Constructor & Destructor Documentation

HPS.Publish.ViewKit.ViewKit ( )

The default constructor creates an empty ViewKit object.

HPS.Publish.ViewKit.ViewKit ( HPS.Publish.ViewKit  in_kit)

The copy constructor creates a new ViewKit object that contains the same settings as the source ViewKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_view_kit" kindref="compound">ViewKit</ref> to copy.

Member Function Documentation

override bool HPS.Publish.ViewKit.Empty ( )
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 ( HPS.Publish.ViewKit  in_kit)

Check if the source ViewKit is equivalent to this ViewKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_view_kit" kindref="compound">ViewKit</ref> to compare to this <ref refid="class_h_p_s_1_1_publish_1_1_view_kit" kindref="compound">ViewKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Publish.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.
override HPS.Type HPS.Publish.ViewKit.ObjectType ( )
virtual

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.

void HPS.Publish.ViewKit.Set ( HPS.Publish.ViewKit  in_kit)

Copies the source ViewKit into this ViewKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_view_kit" kindref="compound">ViewKit</ref> to copy.
HPS.Publish.ViewKit 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/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_view_data.html#a42b3a961b62e86668dd6d40462e8c603">A3DPDFViewData::m_sViewBackgroundColor</ulink>.

Parameters
in_colorThe background color for the view.
Returns
A reference to this ViewKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_view_data.html#a9f79bebe0e2d6ac6d29fc253d1414b4f">A3DPDFViewData::m_sPosition</ulink>, <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_view_data.html#aa29602b2ea96c0ce793040deb2ba8fc5">A3DPDFViewData::m_sTarget</ulink>, <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_view_data.html#a18bf7ccfc0451bf52b1cee32dbceab9b">A3DPDFViewData::m_sUpVector</ulink>, <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_view_data.html#a00eae0ff4d0f145787406c729dc83c4b">A3DPDFViewData::m_dZoomFactor</ulink>, <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_view_data.html#a472edf22d468eeb5e834b5fea777d75c">A3DPDFViewData::m_eProjectionMode</ulink>, and <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_view_data.html#aa7056b8577c01d37bc5e9af4e008011a">A3DPDFViewData::m_dFieldOfView</ulink>.

Parameters
in_cameraThe camera for the view.
Returns
A reference to this ViewKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_view_data.html#a4d03a8c18f745487873eb3090da55537">A3DPDFViewData::m_bIsDefault</ulink>.

Parameters
in_stateWhether this view is the default view.
Returns
A reference to this ViewKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_view_data.html#a3accdda36cd587f78f3e7ff3d85b9893">A3DPDFViewData::m_pcExternalName</ulink>.

Parameters
in_nameUTF8-encoded external name for the view.
Returns
A reference to this ViewKit.
HPS.Publish.ViewKit HPS.Publish.ViewKit.SetInternalName ( string  in_name)

Sets the internal name for the view.

Parameters
in_nameUTF8-encoded internal name for the view. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_view_data.html#a7c24dce66db9041eb6411204268a7517">A3DPDFViewData::m_pcInternalName</ulink>.
Returns
A reference to this ViewKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_view_data.html#a1f60c93ea54c67cb0690bcd4bd2e9c89">A3DPDFViewData::m_eViewLighting</ulink>.

Parameters
in_modeThe lighting mode for the view.
Returns
A reference to this ViewKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_view_data.html#a0003ea03bb292482032038a017eebb8a">A3DPDFViewData::m_eRenderingStyle</ulink>.

Parameters
in_modeThe rendering mode for the view.
Returns
A reference to this ViewKit.
void HPS.Publish.ViewKit.Show ( out HPS.Publish.ViewKit  out_kit)

Copies this ViewKit into the given ViewKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_publish_1_1_view_kit" kindref="compound">ViewKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_publish_1_1_view_kit" kindref="compound">ViewKit</ref>.
bool HPS.Publish.ViewKit.ShowBackgroundColor ( out HPS.RGBColor  out_color)

Shows the background color for the view.

Parameters
out_colorThe background color for the view.
Returns
true if a background color was specified, false otherwise.
bool HPS.Publish.ViewKit.ShowCamera ( out HPS.CameraKit  out_camera)

Shows the camera setting.

Parameters
out_cameraThe camera for the view.
Returns
true if a camera was specified, false otherwise.
bool HPS.Publish.ViewKit.ShowDefault ( out bool  out_state)

Shows the default setting.

Parameters
out_stateWhether this view is the default view.
Returns
true if a default setting was specified, false otherwise.
bool HPS.Publish.ViewKit.ShowExternalName ( out string  out_name)

Shows the external name setting.

Parameters
out_nameThe external name for the view.
Returns
true if an external name was specified, false otherwise.
bool HPS.Publish.ViewKit.ShowInternalName ( out string  out_name)

Shows the internal name setting.

Parameters
out_nameThe internal name for the view.
Returns
true if an internal name was specified, false otherwise.
bool HPS.Publish.ViewKit.ShowLighting ( out HPS.Publish.Lighting.Mode  out_mode)

Shows the lighting mode for the view.

Parameters
out_modeThe lighting mode for the view.
Returns
true if a lighting mode was specified, false otherwise.
bool HPS.Publish.ViewKit.ShowRendering ( out HPS.Publish.Rendering.Mode  out_mode)

Shows the rendering mode for the view.

Parameters
out_modeThe rendering mode for the view.
Returns
true if a rendering mode was specified, false otherwise.
HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetBackgroundColor ( )

Removes the background color setting

Returns
A reference to this ViewKit.
HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetCamera ( )

Removes the camera setting.

Returns
A reference to this ViewKit.
HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetDefault ( )

Removes the default setting.

Returns
A reference to this ViewKit.
HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetEverything ( )

Removes all data from the view.

Returns
A reference to this ViewKit.
HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetExternalName ( )

Removes the external name setting.

Returns
A reference to this ViewKit.
HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetInternalName ( )

Removes the internal name setting.

Returns
A reference to this ViewKit.
HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetLighting ( )

Removes the lighting mode setting

Returns
A reference to this ViewKit.
HPS.Publish.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: