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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.ViewKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Publish.ViewKit in_kit)
 
HPS.Publish.ViewKit SetBackgroundColor (HPS.RGBColor in_color)
 
HPS.Publish.ViewKit SetCamera (HPS.CameraKit in_camera)
 
HPS.Publish.ViewKit SetDefault (bool in_state)
 
HPS.Publish.ViewKit SetExternalName (string in_name)
 
HPS.Publish.ViewKit SetInternalName (string in_name)
 
HPS.Publish.ViewKit SetLighting (HPS.Publish.Lighting.Mode in_mode)
 
HPS.Publish.ViewKit SetRendering (HPS.Publish.Rendering.Mode in_mode)
 
void Show (out HPS.Publish.ViewKit out_kit)
 
bool ShowBackgroundColor (out HPS.RGBColor out_color)
 
bool ShowCamera (out HPS.CameraKit out_camera)
 
bool ShowDefault (out bool out_state)
 
bool ShowExternalName (out string out_name)
 
bool ShowInternalName (out string out_name)
 
bool ShowLighting (out HPS.Publish.Lighting.Mode out_mode)
 
bool ShowRendering (out HPS.Publish.Rendering.Mode out_mode)
 
HPS.Publish.ViewKit UnsetBackgroundColor ()
 
HPS.Publish.ViewKit UnsetCamera ()
 
HPS.Publish.ViewKit UnsetDefault ()
 
HPS.Publish.ViewKit UnsetEverything ()
 
HPS.Publish.ViewKit UnsetExternalName ()
 
HPS.Publish.ViewKit UnsetInternalName ()
 
HPS.Publish.ViewKit UnsetLighting ()
 
HPS.Publish.ViewKit UnsetRendering ()
 
 ViewKit ()
 
 ViewKit (HPS.Publish.ViewKit in_kit)
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Publish.ViewKit GetDefault ()
 
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

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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

◆ ViewKit() [1/2]

HPS.Publish.ViewKit.ViewKit ( )
inline

The default constructor creates an empty ViewKit object.

◆ ViewKit() [2/2]

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

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

Parameters
in_kitThe source ViewKit to copy.

Member Function Documentation

◆ 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()

bool HPS.Publish.ViewKit.Equals ( HPS.Publish.ViewKit  in_kit)
inline

Check if the source ViewKit is equivalent to this ViewKit.

Parameters
in_kitThe source ViewKit to compare to this ViewKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.Publish.ViewKit HPS.Publish.ViewKit.GetDefault ( )
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.

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()

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

Copies the source ViewKit into this ViewKit.

Parameters
in_kitThe source ViewKit to copy.

◆ SetBackgroundColor()

HPS.Publish.ViewKit HPS.Publish.ViewKit.SetBackgroundColor ( HPS.RGBColor  in_color)
inline

Sets the background color for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_sViewBackgroundColor.

Parameters
in_colorThe background color for the view.
Returns
A reference to this ViewKit.

◆ SetCamera()

HPS.Publish.ViewKit HPS.Publish.ViewKit.SetCamera ( HPS.CameraKit  in_camera)
inline

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.

Parameters
in_cameraThe camera for the view.
Returns
A reference to this ViewKit.

◆ SetDefault()

HPS.Publish.ViewKit HPS.Publish.ViewKit.SetDefault ( bool  in_state)
inline

Sets whether this view is the default view. This corresponds to the value that will be passed to A3DPDFViewData::m_bIsDefault.

Parameters
in_stateWhether this view is the default view.
Returns
A reference to this ViewKit.

◆ SetExternalName()

HPS.Publish.ViewKit HPS.Publish.ViewKit.SetExternalName ( string  in_name)
inline

Sets the external name for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_pcExternalName.

Parameters
in_nameUTF8-encoded external name for the view.
Returns
A reference to this ViewKit.

◆ SetInternalName()

HPS.Publish.ViewKit HPS.Publish.ViewKit.SetInternalName ( string  in_name)
inline

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

◆ SetLighting()

HPS.Publish.ViewKit HPS.Publish.ViewKit.SetLighting ( HPS.Publish.Lighting.Mode  in_mode)
inline

Sets the lighting mode for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_eViewLighting.

Parameters
in_modeThe lighting mode for the view.
Returns
A reference to this ViewKit.

◆ SetRendering()

HPS.Publish.ViewKit HPS.Publish.ViewKit.SetRendering ( HPS.Publish.Rendering.Mode  in_mode)
inline

Sets the rendering mode for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_eRenderingStyle.

Parameters
in_modeThe rendering mode for the view.
Returns
A reference to this ViewKit.

◆ Show()

void HPS.Publish.ViewKit.Show ( out HPS.Publish.ViewKit  out_kit)
inline

Copies this ViewKit into the given ViewKit.

Parameters
out_kitThe ViewKit to populate with the contents of this ViewKit.

◆ ShowBackgroundColor()

bool HPS.Publish.ViewKit.ShowBackgroundColor ( out HPS.RGBColor  out_color)
inline

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.

◆ ShowCamera()

bool HPS.Publish.ViewKit.ShowCamera ( out HPS.CameraKit  out_camera)
inline

Shows the camera setting.

Parameters
out_cameraThe 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_stateWhether 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_nameThe 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_nameThe internal name for the view.
Returns
true if an internal name was specified, false otherwise.

◆ ShowLighting()

bool HPS.Publish.ViewKit.ShowLighting ( out HPS.Publish.Lighting.Mode  out_mode)
inline

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.

◆ ShowRendering()

bool HPS.Publish.ViewKit.ShowRendering ( out HPS.Publish.Rendering.Mode  out_mode)
inline

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.

◆ UnsetBackgroundColor()

HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetBackgroundColor ( )
inline

Removes the background color setting

Returns
A reference to this ViewKit.

◆ UnsetCamera()

HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetCamera ( )
inline

Removes the camera setting.

Returns
A reference to this ViewKit.

◆ UnsetDefault()

HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetDefault ( )
inline

Removes the default setting.

Returns
A reference to this ViewKit.

◆ UnsetEverything()

HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetEverything ( )
inline

Removes all data from the view.

Returns
A reference to this ViewKit.

◆ UnsetExternalName()

HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetExternalName ( )
inline

Removes the external name setting.

Returns
A reference to this ViewKit.

◆ UnsetInternalName()

HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetInternalName ( )
inline

Removes the internal name setting.

Returns
A reference to this ViewKit.

◆ UnsetLighting()

HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetLighting ( )
inline

Removes the lighting mode setting

Returns
A reference to this ViewKit.

◆ UnsetRendering()

HPS.Publish.ViewKit HPS.Publish.ViewKit.UnsetRendering ( )
inline

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