< Home

< Table of Contents

REFERENCE MANUAL

HPS.Publish.ArtworkKit Class Reference

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

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

Public Member Functions

HPS.Publish.ArtworkKit AddView (HPS.Publish.ViewKit in_view)
 Adds a view to the artwork. More...
 
HPS.Publish.ArtworkKit AddViews (HPS.Publish.ViewKit[] in_views)
 Adds views to the artwork. More...
 
 ArtworkKit ()
 The default constructor creates an empty ArtworkKit object. More...
 
 ArtworkKit (HPS.Publish.ArtworkKit in_kit)
 The copy constructor creates a new ArtworkKit object that contains the same settings as the source ArtworkKit. More...
 
override void Dispose ()
 
override bool Empty ()
 Indicates whether this ArtworkKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.ArtworkKit in_kit)
 Check if the source ArtworkKit is equivalent to this ArtworkKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.Publish.ArtworkKit in_kit)
 Copies the source ArtworkKit into this ArtworkKit. More...
 
HPS.Publish.ArtworkKit SetAnimationStyle (HPS.Publish.Animation.Style in_style)
 Sets the animation style for the artwork. More...
 
HPS.Publish.ArtworkKit SetDefaultViewPreference (HPS.Publish.Artwork.View.Preference in_preference)
 Sets the default view preference for the artwork. More...
 
HPS.Publish.ArtworkKit SetDisplayPreference (HPS.Publish.Artwork.Display.Preference in_preference)
 Sets the display preference for the artwork. More...
 
HPS.Publish.ArtworkKit SetJavaScript (string in_source, HPS.Publish.Source.Type in_type)
 Sets the JavaScript source or file for the artwork. More...
 
HPS.Publish.ArtworkKit SetJavaScript (string in_source)
 Sets the JavaScript source or file for the artwork. More...
 
HPS.Publish.ArtworkKit SetPMIColor (HPS.RGBColor in_pmi_color)
 Sets the PMI color for this artwork. More...
 
HPS.Publish.ArtworkKit SetPMICrossHighlighting (bool in_state)
 Sets the whether to enable PMI cross-highlighting for the artwork. More...
 
HPS.Publish.ArtworkKit SetPMISemanticInformation (bool in_state)
 Sets the whether to include semantic PMI information in the artwork. More...
 
HPS.Publish.ArtworkKit SetView (HPS.Publish.ViewKit in_view)
 Adds a view to the artwork. More...
 
HPS.Publish.ArtworkKit SetViews (HPS.Publish.ViewKit[] in_views)
 Adds views to the artwork. More...
 
void Show (out HPS.Publish.ArtworkKit out_kit)
 Copies this ArtworkKit into the given ArtworkKit. More...
 
bool ShowAnimationStyle (out HPS.Publish.Animation.Style out_style)
 Shows the animation style setting. More...
 
bool ShowDefaultViewPreference (out HPS.Publish.Artwork.View.Preference out_preference)
 Shows the default view preference setting. More...
 
bool ShowDisplayPreference (out HPS.Publish.Artwork.Display.Preference out_preference)
 Shows the display preference setting. More...
 
bool ShowJavaScript (out string out_source, out HPS.Publish.Source.Type out_type)
 Shows the JavaScript setting. More...
 
bool ShowPMIColor (out HPS.RGBColor out_pmi_color)
 Shows the PMI color for the artwork. More...
 
bool ShowPMICrossHighlighting (out bool out_state)
 Shows the PMI cross-highlighting setting. More...
 
bool ShowPMISemanticInformation (out bool out_state)
 Shows the semantic PMI information setting. More...
 
bool ShowViews (out HPS.Publish.ViewKit[] out_views)
 Shows the views for the artwork. More...
 
HPS.Publish.ArtworkKit UnsetAnimationStyle ()
 Removes the animation style setting. More...
 
HPS.Publish.ArtworkKit UnsetDefaultViewPreference ()
 Removes the default view preference setting. More...
 
HPS.Publish.ArtworkKit UnsetDisplayPreference ()
 Removes the display preference setting. More...
 
HPS.Publish.ArtworkKit UnsetEverything ()
 Removes all data from the artwork. More...
 
HPS.Publish.ArtworkKit UnsetJavaScript ()
 Removes the JavaScript setting. More...
 
HPS.Publish.ArtworkKit UnsetPMIColor ()
 Removes the PMI color setting from the artwork. More...
 
HPS.Publish.ArtworkKit UnsetPMICrossHighlighting ()
 Removes the PMI cross-highlighting setting. More...
 
HPS.Publish.ArtworkKit UnsetPMISemanticInformation ()
 Removes the PMI semantic information setting. More...
 
HPS.Publish.ArtworkKit UnsetView (ulong in_index)
 Removes the view at the given index from the artwork. More...
 
HPS.Publish.ArtworkKit UnsetViews (ulong[] in_indices)
 Removes the views at the given indices from the artwork. More...
 
HPS.Publish.ArtworkKit UnsetViews ()
 Removes all views from the artwork. 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.ArtworkKit GetDefault ()
 Creates a ArtworkKit which contains the default settings. More...
 
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

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

HPS.Publish.ArtworkKit.ArtworkKit ( )

The default constructor creates an empty ArtworkKit object.

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

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_artwork_kit" kindref="compound">ArtworkKit</ref> to copy.

Member Function Documentation

HPS.Publish.ArtworkKit 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__3_dartwork__module.html#gaba259ad2983a5e64ca6dcf5fe4415d71">A3DPDF3DArtworkAddView</ulink>.

Parameters
in_viewThe view to add to the artwork.
Returns
A reference to this ArtworkKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__3_dartwork__module.html#gaba259ad2983a5e64ca6dcf5fe4415d71">A3DPDF3DArtworkAddView</ulink>.

Parameters
in_countSize of the following array.
in_viewsThe views to add to the artwork.
Returns
A reference to this ArtworkKit.
override bool HPS.Publish.ArtworkKit.Empty ( )
virtual

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.

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

Check if the source ArtworkKit is equivalent to this ArtworkKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_artwork_kit" kindref="compound">ArtworkKit</ref> to compare to this <ref refid="class_h_p_s_1_1_publish_1_1_artwork_kit" kindref="compound">ArtworkKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.GetDefault ( )
static

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

Copies the source ArtworkKit into this ArtworkKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_artwork_kit" kindref="compound">ArtworkKit</ref> to copy.
HPS.Publish.ArtworkKit 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f3_d_artwork_data.html#a089d0a8180bf79e10b7cdb073057af4f">A3DPDF3DArtworkData::m_eAnimationStyle</ulink>.

Parameters
in_styleThe animation style for the artwork.
Returns
A reference to this ArtworkKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f3_d_artwork_data.html#afe11fda891b6db864619a756e1ad2d9e">A3DPDF3DArtworkData::m_bKeepNativeDefaultView</ulink>.

Parameters
in_preferenceThe default view preference for the artwork.
Returns
A reference to this ArtworkKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f3_d_artwork_data.html#a16f183ec39e59f7ae82a28ac7a228c2f">A3DPDF3DArtworkData::m_bUseRuntimeDisplaySettings</ulink>.

Parameters
in_preferenceThe display preference for the artwork.
Returns
A reference to this ArtworkKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f3_d_artwork_data.html#a69830b86e02e28fdb07c6d5bbda2db90">A3DPDF3DArtworkData::m_pcJavaScriptFileName</ulink>.

Parameters
in_sourceThe JavaScript source or file (depending on the next argument) for the artwork.
in_typeThe type of the preceding argument. Defaults to <ref refid="class_h_p_s_1_1_publish_1_1_source_1a5e72b242e24c67a4d9d777bce395bb92aca0dbad92a874b2f69b549293387925e" kindref="member">Source::Type::Code</ref>.
Returns
A reference to this ArtworkKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f3_d_artwork_data.html#a69830b86e02e28fdb07c6d5bbda2db90">A3DPDF3DArtworkData::m_pcJavaScriptFileName</ulink>.

Parameters
in_sourceThe JavaScript source or file (depending on the next argument) for the artwork.
Returns
A reference to this ArtworkKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f3_d_artwork_data.html#a3aeb63d2227167cb586c87471844e712">A3DPDF3DArtworkData::m_sPMIColor </ulink>.

Parameters
in_pmi_colorThe color to apply to PMIs for this artwork.
Returns
A reference to this ArtworkKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f3_d_artwork_data.html#a57f639f84cc5d856af6cc99b61d219b6">A3DPDF3DArtworkData::m_bActivatePMICrossHighlight</ulink>.

Parameters
in_stateWhether to highlight the geometry associated with a piece of PMI when that PMI is selected.
Returns
A reference to this ArtworkKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f3_d_artwork_data.html#a3fd0cdd9fbd980c695013b97f16a3c4f">A3DPDF3DArtworkData::m_bAddPMISemanticInformation</ulink>.

Parameters
in_stateWhether to include semantic PMI information in the artwork.
Returns
A reference to this ArtworkKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__3_dartwork__module.html#gaba259ad2983a5e64ca6dcf5fe4415d71">A3DPDF3DArtworkAddView</ulink>.

Parameters
in_viewThe view to add to the artwork.
Returns
A reference to this ArtworkKit.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__3_dartwork__module.html#gaba259ad2983a5e64ca6dcf5fe4415d71">A3DPDF3DArtworkAddView</ulink>.

Parameters
in_countSize of the following array.
in_viewsThe views to add to the artwork.
Returns
A reference to this ArtworkKit.
void HPS.Publish.ArtworkKit.Show ( out HPS.Publish.ArtworkKit  out_kit)

Copies this ArtworkKit into the given ArtworkKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_publish_1_1_artwork_kit" kindref="compound">ArtworkKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_publish_1_1_artwork_kit" kindref="compound">ArtworkKit</ref>.
bool HPS.Publish.ArtworkKit.ShowAnimationStyle ( out HPS.Publish.Animation.Style  out_style)

Shows the animation style setting.

Parameters
out_styleThe animation style of the artwork.
Returns
true if an animation style was specified, false otherwise.
bool HPS.Publish.ArtworkKit.ShowDefaultViewPreference ( out HPS.Publish.Artwork.View.Preference  out_preference)

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.
bool HPS.Publish.ArtworkKit.ShowDisplayPreference ( out HPS.Publish.Artwork.Display.Preference  out_preference)

Shows the display preference setting.

Parameters
out_preferenceThe display preference for the artwork.
Returns
true if a display preference was specified, false otherwise.
bool HPS.Publish.ArtworkKit.ShowJavaScript ( out string  out_source,
out HPS.Publish.Source.Type  out_type 
)

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.
bool HPS.Publish.ArtworkKit.ShowPMIColor ( out HPS.RGBColor  out_pmi_color)

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.
bool HPS.Publish.ArtworkKit.ShowPMICrossHighlighting ( out bool  out_state)

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.
bool HPS.Publish.ArtworkKit.ShowPMISemanticInformation ( out bool  out_state)

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.
bool HPS.Publish.ArtworkKit.ShowViews ( out HPS.Publish.ViewKit[]  out_views)

Shows the views for the artwork.

Parameters
out_viewsThe views for the artwork.
Returns
true if views were specified, false otherwise.
HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetAnimationStyle ( )

Removes the animation style setting.

Returns
A reference to this ArtworkKit.
HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetDefaultViewPreference ( )

Removes the default view preference setting.

Returns
A reference to this ArtworkKit.
HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetDisplayPreference ( )

Removes the display preference setting.

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

Removes all data from the artwork.

Returns
A reference to this ArtworkKit.
HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetJavaScript ( )

Removes the JavaScript setting.

Returns
A reference to this ArtworkKit.
HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetPMIColor ( )

Removes the PMI color setting from the artwork.

Returns
A reference to this ArtworkKit.
HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetPMICrossHighlighting ( )

Removes the PMI cross-highlighting setting.

Returns
A reference to this ArtworkKit.
HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetPMISemanticInformation ( )

Removes the PMI semantic information setting.

Returns
A reference to this ArtworkKit.
HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetView ( ulong  in_index)

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.
HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetViews ( ulong[]  in_indices)

Removes the views at the given indices from the artwork.

Parameters
in_countSize of the following array.
in_indicesIndices of the views to remove from the artwork.
Returns
A reference to this ArtworkKit.
HPS.Publish.ArtworkKit HPS.Publish.ArtworkKit.UnsetViews ( )

Removes all views from the artwork.

Returns
A reference to this ArtworkKit.

The documentation for this class was generated from the following file: