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

Public Member Functions

HPS.Publish.ArtworkKit AddView (HPS.Publish.ViewKit in_view)
 
HPS.Publish.ArtworkKit AddViews (HPS.Publish.ViewKit[] in_views)
 
 ArtworkKit ()
 
 ArtworkKit (HPS.Publish.ArtworkKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.ArtworkKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Publish.ArtworkKit in_kit)
 
HPS.Publish.ArtworkKit SetAnimationStyle (HPS.Publish.Animation.Style in_style)
 
HPS.Publish.ArtworkKit SetDefaultViewPreference (HPS.Publish.Artwork.View.Preference in_preference)
 
HPS.Publish.ArtworkKit SetDisplayPreference (HPS.Publish.Artwork.Display.Preference in_preference)
 
HPS.Publish.ArtworkKit SetJavaScript (string in_source, HPS.Publish.Source.Type in_type)
 
HPS.Publish.ArtworkKit SetJavaScript (string in_source)
 
HPS.Publish.ArtworkKit SetPMIColor (HPS.RGBColor in_pmi_color)
 
HPS.Publish.ArtworkKit SetPMICrossHighlighting (bool in_state)
 
HPS.Publish.ArtworkKit SetPMISemanticInformation (bool in_state)
 
HPS.Publish.ArtworkKit SetView (HPS.Publish.ViewKit in_view)
 
HPS.Publish.ArtworkKit SetViews (HPS.Publish.ViewKit[] in_views)
 
void Show (out HPS.Publish.ArtworkKit out_kit)
 
bool ShowAnimationStyle (out HPS.Publish.Animation.Style out_style)
 
bool ShowDefaultViewPreference (out HPS.Publish.Artwork.View.Preference out_preference)
 
bool ShowDisplayPreference (out HPS.Publish.Artwork.Display.Preference out_preference)
 
bool ShowJavaScript (out string out_source, out HPS.Publish.Source.Type out_type)
 
bool ShowPMIColor (out HPS.RGBColor out_pmi_color)
 
bool ShowPMICrossHighlighting (out bool out_state)
 
bool ShowPMISemanticInformation (out bool out_state)
 
bool ShowViews (out HPS.Publish.ViewKit[] out_views)
 
HPS.Publish.ArtworkKit UnsetAnimationStyle ()
 
HPS.Publish.ArtworkKit UnsetDefaultViewPreference ()
 
HPS.Publish.ArtworkKit UnsetDisplayPreference ()
 
HPS.Publish.ArtworkKit UnsetEverything ()
 
HPS.Publish.ArtworkKit UnsetJavaScript ()
 
HPS.Publish.ArtworkKit UnsetPMIColor ()
 
HPS.Publish.ArtworkKit UnsetPMICrossHighlighting ()
 
HPS.Publish.ArtworkKit UnsetPMISemanticInformation ()
 
HPS.Publish.ArtworkKit UnsetView (ulong in_index)
 
HPS.Publish.ArtworkKit UnsetViews (ulong[] in_indices)
 
HPS.Publish.ArtworkKit UnsetViews ()
 
- 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.ArtworkKit GetDefault ()
 
static bool operator!= (HPS.Publish.ArtworkKit a, HPS.Publish.ArtworkKit b)
 
static bool operator== (HPS.Publish.ArtworkKit a, HPS.Publish.ArtworkKit 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 ArtworkKit class is a user space object. It acts as the container for all data that can be on an artwork in a Publish PDF.

Constructor & Destructor Documentation

◆ ArtworkKit() [1/2]

HPS.Publish.ArtworkKit.ArtworkKit ( )
inline

The default constructor creates an empty ArtworkKit object.

◆ ArtworkKit() [2/2]

HPS.Publish.ArtworkKit.ArtworkKit ( HPS.Publish.ArtworkKit  in_kit)
inline

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

Parameters
in_kitThe source ArtworkKit to copy.

Member Function Documentation

◆ AddView()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.AddView ( HPS.Publish.ViewKit  in_view)
inline

Adds a view to the artwork. This will append the view to any existing views on the artwork. These correspond to values that will be passed to A3DPDF3DArtworkAddView.

Parameters
in_viewThe view to add to the artwork.
Returns
A reference to this ArtworkKit.

◆ AddViews()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.AddViews ( HPS.Publish.ViewKit []  in_views)
inline

Adds views to the artwork. This will append the views to any existing views on the artwork. These correspond to values that will be passed to A3DPDF3DArtworkAddView.

Parameters
in_viewsThe views to add to the artwork.
Returns
A reference to this ArtworkKit.

◆ Empty()

override bool HPS.Publish.ArtworkKit.Empty ( )
inlinevirtual

Indicates whether this ArtworkKit has any values set on it.

Returns
true if no values are set on this ArtworkKit, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source ArtworkKit is equivalent to this ArtworkKit.

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

◆ GetDefault()

static HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.GetDefault ( )
inlinestatic

Creates a ArtworkKit 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 ArtworkKit passed to File.Export.

Returns
A ArtworkKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.Publish.ArtworkKit.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.ArtworkKit.Set ( HPS.Publish.ArtworkKit  in_kit)
inline

Copies the source ArtworkKit into this ArtworkKit.

Parameters
in_kitThe source ArtworkKit to copy.

◆ SetAnimationStyle()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.SetAnimationStyle ( HPS.Publish.Animation.Style  in_style)
inline

Sets the animation style for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_eAnimationStyle.

Parameters
in_styleThe animation style for the artwork.
Returns
A reference to this ArtworkKit.

◆ SetDefaultViewPreference()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.SetDefaultViewPreference ( HPS.Publish.Artwork.View.Preference  in_preference)
inline

Sets the default view preference for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_bKeepNativeDefaultView.

Parameters
in_preferenceThe default view preference for the artwork.
Returns
A reference to this ArtworkKit.

◆ SetDisplayPreference()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.SetDisplayPreference ( HPS.Publish.Artwork.Display.Preference  in_preference)
inline

Sets the display preference for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_bUseRuntimeDisplaySettings.

Parameters
in_preferenceThe display preference for the artwork.
Returns
A reference to this ArtworkKit.

◆ SetJavaScript() [1/2]

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.SetJavaScript ( string  in_source,
HPS.Publish.Source.Type  in_type 
)
inline

Sets the JavaScript source or file for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_pcJavaScriptFileName.

Parameters
in_sourceThe JavaScript source or file (depending on the next argument) for the artwork.
in_typeThe type of the preceding argument. Defaults to Source.Type.Code.
Returns
A reference to this ArtworkKit.

◆ SetJavaScript() [2/2]

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.SetJavaScript ( string  in_source)
inline

Sets the JavaScript source or file for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_pcJavaScriptFileName.

Parameters
in_sourceThe JavaScript source or file (depending on the next argument) for the artwork.
Returns
A reference to this ArtworkKit.

◆ SetPMIColor()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.SetPMIColor ( HPS.RGBColor  in_pmi_color)
inline

Sets the PMI color for this artwork. This correspond to value that will be passed to A3DPDF3DArtworkData::m_sPMIColor .

Parameters
in_pmi_colorThe color to apply to PMIs for this artwork.
Returns
A reference to this ArtworkKit.

◆ SetPMICrossHighlighting()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.SetPMICrossHighlighting ( bool  in_state)
inline

Sets the whether to enable PMI cross-highlighting for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_bActivatePMICrossHighlight.

Parameters
in_stateWhether to highlight the geometry associated with a piece of PMI when that PMI is selected.
Returns
A reference to this ArtworkKit.

◆ SetPMISemanticInformation()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.SetPMISemanticInformation ( bool  in_state)
inline

Sets the whether to include semantic PMI information in the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_bAddPMISemanticInformation.

Parameters
in_stateWhether to include semantic PMI information in the artwork.
Returns
A reference to this ArtworkKit.

◆ SetView()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.SetView ( HPS.Publish.ViewKit  in_view)
inline

Adds a view to the artwork. This will replace all views (if any) on the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkAddView.

Parameters
in_viewThe view to add to the artwork.
Returns
A reference to this ArtworkKit.

◆ SetViews()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.SetViews ( HPS.Publish.ViewKit []  in_views)
inline

Adds views to the artwork. This will replace all views (if any) on the artwork. These correspond to values that will be passed to A3DPDF3DArtworkAddView.

Parameters
in_viewsThe views to add to the artwork.
Returns
A reference to this ArtworkKit.

◆ Show()

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

Copies this ArtworkKit into the given ArtworkKit.

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

◆ ShowAnimationStyle()

bool HPS.Publish.ArtworkKit.ShowAnimationStyle ( out HPS.Publish.Animation.Style  out_style)
inline

Shows the animation style setting.

Parameters
out_styleThe animation style of the artwork.
Returns
true if an animation style was specified, false otherwise.

◆ ShowDefaultViewPreference()

bool HPS.Publish.ArtworkKit.ShowDefaultViewPreference ( out HPS.Publish.Artwork.View.Preference  out_preference)
inline

Shows the default view preference setting.

Parameters
out_preferenceThe default view preference for the artwork.
Returns
true if a default view preference was specified, false otherwise.

◆ ShowDisplayPreference()

bool HPS.Publish.ArtworkKit.ShowDisplayPreference ( out HPS.Publish.Artwork.Display.Preference  out_preference)
inline

Shows the display preference setting.

Parameters
out_preferenceThe display preference for the artwork.
Returns
true if a display preference was specified, false otherwise.

◆ ShowJavaScript()

bool HPS.Publish.ArtworkKit.ShowJavaScript ( out string  out_source,
out HPS.Publish.Source.Type  out_type 
)
inline

Shows the JavaScript setting.

Parameters
out_sourceThe JavaScript source or file (depending on the next argument) for the artwork.
out_typeThe type of the preceding argument.
Returns
true if a JavaScript source or file was specified, false otherwise.

◆ ShowPMIColor()

bool HPS.Publish.ArtworkKit.ShowPMIColor ( out HPS.RGBColor  out_pmi_color)
inline

Shows the PMI color for the artwork.

Parameters
out_pmi_colorThe PMI color for the artwork.
Returns
true if a PMI color was specified, false otherwise.

◆ ShowPMICrossHighlighting()

bool HPS.Publish.ArtworkKit.ShowPMICrossHighlighting ( out bool  out_state)
inline

Shows the PMI cross-highlighting setting.

Parameters
out_stateWhether to highlight the geometry associated with a piece of PMI when that PMI is selected.
Returns
true if a PMI cross-highlighting setting was specified, false otherwise.

◆ ShowPMISemanticInformation()

bool HPS.Publish.ArtworkKit.ShowPMISemanticInformation ( out bool  out_state)
inline

Shows the semantic PMI information setting.

Parameters
out_stateWhether to include semantic PMI information in the artwork.
Returns
true if a semantic PMI information setting was specified, false otherwise.

◆ ShowViews()

bool HPS.Publish.ArtworkKit.ShowViews ( out HPS.Publish.ViewKit []  out_views)
inline

Shows the views for the artwork.

Parameters
out_viewsThe views for the artwork.
Returns
true if views were specified, false otherwise.

◆ UnsetAnimationStyle()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetAnimationStyle ( )
inline

Removes the animation style setting.

Returns
A reference to this ArtworkKit.

◆ UnsetDefaultViewPreference()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetDefaultViewPreference ( )
inline

Removes the default view preference setting.

Returns
A reference to this ArtworkKit.

◆ UnsetDisplayPreference()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetDisplayPreference ( )
inline

Removes the display preference setting.

Returns
A reference to this ArtworkKit.

◆ UnsetEverything()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetEverything ( )
inline

Removes all data from the artwork.

Returns
A reference to this ArtworkKit.

◆ UnsetJavaScript()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetJavaScript ( )
inline

Removes the JavaScript setting.

Returns
A reference to this ArtworkKit.

◆ UnsetPMIColor()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetPMIColor ( )
inline

Removes the PMI color setting from the artwork.

Returns
A reference to this ArtworkKit.

◆ UnsetPMICrossHighlighting()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetPMICrossHighlighting ( )
inline

Removes the PMI cross-highlighting setting.

Returns
A reference to this ArtworkKit.

◆ UnsetPMISemanticInformation()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetPMISemanticInformation ( )
inline

Removes the PMI semantic information setting.

Returns
A reference to this ArtworkKit.

◆ UnsetView()

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetView ( ulong  in_index)
inline

Removes the view at the given index from the artwork.

Parameters
in_indexIndex of the view to remove from the artwork.
Returns
A reference to this ArtworkKit.

◆ UnsetViews() [1/2]

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetViews ( ulong []  in_indices)
inline

Removes the views at the given indices from the artwork.

Parameters
in_indicesIndices of the views to remove from the artwork.
Returns
A reference to this ArtworkKit.

◆ UnsetViews() [2/2]

HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetViews ( )
inline

Removes all views from the artwork.

Returns
A reference to this ArtworkKit.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_publish/source/cs/HPS.Publish.cs