HPS.Publish.ArtworkKit

class HPS.Publish.ArtworkKit : public HPS.SprocketKit 

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.

Public Functions

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

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.

Param in_view: The view to add to the artwork.
Return: A reference to this ArtworkKit.

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

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.

Param in_views: The views to add to the artwork.
Return: A reference to this ArtworkKit.

ArtworkKit (): The default constructor creates an empty ArtworkKit object.

ArtworkKit (HPS.Publish.ArtworkKit in_kit)

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

Param in_kit: The source ArtworkKit to copy.

override bool Empty ()

Indicates whether this ArtworkKit has any values set on it.

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

bool Equals (HPS.Publish.ArtworkKit in_kit)

Check if the source ArtworkKit is equivalent to this ArtworkKit.

Param in_kit: The source ArtworkKit to compare to this ArtworkKit.
Return: true if the objects are equivalent, false otherwise.

override HPS.Type ObjectType ()

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

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Publish.ArtworkKit in_kit)

Copies the source ArtworkKit into this ArtworkKit.

Param in_kit: The source ArtworkKit to copy.

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

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

Param in_style: The animation style for the artwork.
Return: A reference to this ArtworkKit.

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

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

Param in_preference: The default view preference for the artwork.
Return: A reference to this ArtworkKit.

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

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

Param in_preference: The display preference for the artwork.
Return: A reference to this ArtworkKit.

HPS.Publish.ArtworkKit SetJavaScript (string in_source)

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

Param in_source: The JavaScript source or file (depending on the next argument) for the artwork.
Return: A reference to this ArtworkKit.

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

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

Param in_source: The JavaScript source or file (depending on the next argument) for the artwork.
Param in_type: The type of the preceding argument. Defaults to Source.Type.Code.
Return: A reference to this ArtworkKit.

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

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

Param in_pmi_color: The color to apply to PMIs for this artwork.
Return: A reference to this ArtworkKit.

HPS.Publish.ArtworkKit SetPMICrossHighlighting (bool in_state)

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

Param in_state: Whether to highlight the geometry associated with a piece of PMI when that PMI is selected.
Return: A reference to this ArtworkKit.

HPS.Publish.ArtworkKit SetPMISemanticInformation (bool in_state)

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

Param in_state: Whether to include semantic PMI information in the artwork.
Return: A reference to this ArtworkKit.

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

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.

Param in_view: The view to add to the artwork.
Return: A reference to this ArtworkKit.

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

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.

Param in_views: The views to add to the artwork.
Return: A reference to this ArtworkKit.

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

Copies this ArtworkKit into the given ArtworkKit.

Param out_kit: The ArtworkKit to populate with the contents of this ArtworkKit.

bool ShowAnimationStyle (out HPS.Publish.Animation.Style out_style)

Shows the animation style setting.

Param out_style: The animation style of the artwork.
Return: true if an animation style was specified, false otherwise.

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

Shows the default view preference setting.

Param out_preference: The default view preference for the artwork.
Return: true if a default view preference was specified, false otherwise.

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

Shows the display preference setting.

Param out_preference: The display preference for the artwork.
Return: true if a display preference was specified, false otherwise.

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

Shows the JavaScript setting.

Param out_source: The JavaScript source or file (depending on the next argument) for the artwork.
Param out_type: The type of the preceding argument.
Return: true if a JavaScript source or file was specified, false otherwise.

bool ShowPMIColor (out HPS.RGBColor out_pmi_color)

Shows the PMI color for the artwork.

Param out_pmi_color: The PMI color for the artwork.
Return: true if a PMI color was specified, false otherwise.

bool ShowPMICrossHighlighting (out bool out_state)

Shows the PMI cross-highlighting setting.

Param out_state: Whether to highlight the geometry associated with a piece of PMI when that PMI is selected.
Return: true if a PMI cross-highlighting setting was specified, false otherwise.

bool ShowPMISemanticInformation (out bool out_state)

Shows the semantic PMI information setting.

Param out_state: Whether to include semantic PMI information in the artwork.
Return: true if a semantic PMI information setting was specified, false otherwise.

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

Shows the views for the artwork.

Param out_views: The views for the artwork.
Return: true if views were specified, false otherwise.

HPS.Publish.ArtworkKit UnsetAnimationStyle ()

Removes the animation style setting.

Return: A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetDefaultViewPreference ()

Removes the default view preference setting.

Return: A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetDisplayPreference ()

Removes the display preference setting.

Return: A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetEverything ()

Removes all data from the artwork.

Return: A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetJavaScript ()

Removes the JavaScript setting.

Return: A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetPMIColor ()

Removes the PMI color setting from the artwork.

Return: A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetPMICrossHighlighting ()

Removes the PMI cross-highlighting setting.

Return: A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetPMISemanticInformation ()

Removes the PMI semantic information setting.

Return: A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetView (ulong in_index)

Removes the view at the given index from the artwork.

Param in_index: Index of the view to remove from the artwork.
Return: A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetViews ()

Removes all views from the artwork.

Return: A reference to this ArtworkKit.

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

Removes the views at the given indices from the artwork.

Param in_indices: Indices of the views to remove from the artwork.
Return: A reference to this ArtworkKit.

Public Static Functions

HPS.Publish.ArtworkKit GetDefault ()

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.

Return: A ArtworkKit with the default settings.