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. More...
Public Member Functions | |
override void | Dispose () |
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 HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.Publish.ArtworkKit in_kit) |
Copies the source ArtworkKit into this ArtworkKit. More... | |
void | Show (out HPS.Publish.ArtworkKit out_kit) |
Copies this ArtworkKit into the given ArtworkKit. More... | |
override bool | Empty () |
Indicates whether this ArtworkKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.Publish.ArtworkKit in_kit) |
Check if the source ArtworkKit is equivalent to this ArtworkKit. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#a089d0a8180bf79e10b7cdb073057af4f">A3DPDF3DArtworkData::m_eAnimationStyle</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#a69830b86e02e28fdb07c6d5bbda2db90">A3DPDF3DArtworkData::m_pcJavaScriptFileName</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#a69830b86e02e28fdb07c6d5bbda2db90">A3DPDF3DArtworkData::m_pcJavaScriptFileName</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#a57f639f84cc5d856af6cc99b61d219b6">A3DPDF3DArtworkData::m_bActivatePMICrossHighlight</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#a3fd0cdd9fbd980c695013b97f16a3c4f">A3DPDF3DArtworkData::m_bAddPMISemanticInformation</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#afe11fda891b6db864619a756e1ad2d9e">A3DPDF3DArtworkData::m_bKeepNativeDefaultView</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#a16f183ec39e59f7ae82a28ac7a228c2f">A3DPDF3DArtworkData::m_bUseRuntimeDisplaySettings</ulink>. More... | |
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/publish/latest/build/api_ref/group__a3d__publish__3_dartwork__module.html#gaba259ad2983a5e64ca6dcf5fe4415d71">A3DPDF3DArtworkAddView</ulink>. More... | |
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/publish/latest/build/api_ref/group__a3d__publish__3_dartwork__module.html#gaba259ad2983a5e64ca6dcf5fe4415d71">A3DPDF3DArtworkAddView</ulink>. More... | |
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/publish/latest/build/api_ref/group__a3d__publish__3_dartwork__module.html#gaba259ad2983a5e64ca6dcf5fe4415d71">A3DPDF3DArtworkAddView</ulink>. More... | |
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/publish/latest/build/api_ref/group__a3d__publish__3_dartwork__module.html#gaba259ad2983a5e64ca6dcf5fe4415d71">A3DPDF3DArtworkAddView</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#a3aeb63d2227167cb586c87471844e712">A3DPDF3DArtworkData::m_sPMIColor </ulink>. More... | |
HPS.Publish.ArtworkKit | UnsetAnimationStyle () |
Removes the animation style setting. More... | |
HPS.Publish.ArtworkKit | UnsetJavaScript () |
Removes the JavaScript setting. 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 | UnsetDefaultViewPreference () |
Removes the default view preference setting. More... | |
HPS.Publish.ArtworkKit | UnsetDisplayPreference () |
Removes the display preference 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... | |
HPS.Publish.ArtworkKit | UnsetPMIColor () |
Removes the PMI color setting from the artwork. More... | |
HPS.Publish.ArtworkKit | UnsetEverything () |
Removes all data from the artwork. More... | |
bool | ShowAnimationStyle (out HPS.Publish.Animation.Style out_style) |
Shows the animation style setting. More... | |
bool | ShowJavaScript (out string out_source, out HPS.Publish.Source.Type out_type) |
Shows the JavaScript setting. 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 | 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 | ShowViews (out HPS.Publish.ViewKit[] out_views) |
Shows the views for the artwork. More... | |
bool | ShowPMIColor (out HPS.RGBColor out_pmi_color) |
Shows the PMI color for the artwork. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object that) | |
HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Static Public Member Functions | |
static 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. More... | |
static bool | operator== (HPS.Publish.ArtworkKit a, HPS.Publish.ArtworkKit b) |
static bool | operator!= (HPS.Publish.ArtworkKit a, HPS.Publish.ArtworkKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
The type of update to perform, either synchronous or asynchronous. More... | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
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.
|
inline |
The default constructor creates an empty ArtworkKit object.
|
inline |
The copy constructor creates a new ArtworkKit object that contains the same settings as the source ArtworkKit.
in_kit | The source ArtworkKit to copy. |
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__3_dartwork__module.html#gaba259ad2983a5e64ca6dcf5fe4415d71">A3DPDF3DArtworkAddView</ulink>.
in_view | The view to add to the artwork. |
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__3_dartwork__module.html#gaba259ad2983a5e64ca6dcf5fe4415d71">A3DPDF3DArtworkAddView</ulink>.
in_views | The views to add to the artwork. |
|
inlinevirtual |
Indicates whether this ArtworkKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source ArtworkKit is equivalent to this ArtworkKit.
in_kit | The source ArtworkKit to compare to this ArtworkKit. |
|
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
Copies the source ArtworkKit into this ArtworkKit.
in_kit | The source ArtworkKit to copy. |
|
inline |
Sets the animation style for the artwork. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#a089d0a8180bf79e10b7cdb073057af4f">A3DPDF3DArtworkData::m_eAnimationStyle</ulink>.
in_style | The animation style for the artwork. |
|
inline |
Sets the default view preference for the artwork. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#afe11fda891b6db864619a756e1ad2d9e">A3DPDF3DArtworkData::m_bKeepNativeDefaultView</ulink>.
in_preference | The default view preference for the artwork. |
|
inline |
Sets the display preference for the artwork. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#a16f183ec39e59f7ae82a28ac7a228c2f">A3DPDF3DArtworkData::m_bUseRuntimeDisplaySettings</ulink>.
in_preference | The display preference for the artwork. |
|
inline |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#a69830b86e02e28fdb07c6d5bbda2db90">A3DPDF3DArtworkData::m_pcJavaScriptFileName</ulink>.
in_source | The JavaScript source or file (depending on the next argument) for the artwork. |
in_type | The type of the preceding argument. Defaults to Source::Type::Code. |
|
inline |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#a69830b86e02e28fdb07c6d5bbda2db90">A3DPDF3DArtworkData::m_pcJavaScriptFileName</ulink>.
in_source | The JavaScript source or file (depending on the next argument) for the artwork. |
|
inline |
Sets the PMI color for this artwork. This correspond to value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#a3aeb63d2227167cb586c87471844e712">A3DPDF3DArtworkData::m_sPMIColor </ulink>.
in_pmi_color | The color to apply to PMIs for this artwork. |
|
inline |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#a57f639f84cc5d856af6cc99b61d219b6">A3DPDF3DArtworkData::m_bActivatePMICrossHighlight</ulink>.
in_state | Whether to highlight the geometry associated with a piece of PMI when that PMI is selected. |
|
inline |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_artwork_data.html#a3fd0cdd9fbd980c695013b97f16a3c4f">A3DPDF3DArtworkData::m_bAddPMISemanticInformation</ulink>.
in_state | Whether to include semantic PMI information in the artwork. |
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__3_dartwork__module.html#gaba259ad2983a5e64ca6dcf5fe4415d71">A3DPDF3DArtworkAddView</ulink>.
in_view | The view to add to the artwork. |
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__3_dartwork__module.html#gaba259ad2983a5e64ca6dcf5fe4415d71">A3DPDF3DArtworkAddView</ulink>.
in_views | The views to add to the artwork. |
|
inline |
Copies this ArtworkKit into the given ArtworkKit.
out_kit | The ArtworkKit to populate with the contents of this ArtworkKit. |
|
inline |
Shows the animation style setting.
out_style | The animation style of the artwork. |
|
inline |
Shows the default view preference setting.
out_preference | The default view preference for the artwork. |
|
inline |
Shows the display preference setting.
out_preference | The display preference for the artwork. |
|
inline |
Shows the JavaScript setting.
out_source | The JavaScript source or file (depending on the next argument) for the artwork. |
out_type | The type of the preceding argument. |
|
inline |
Shows the PMI color for the artwork.
out_pmi_color | The PMI color for the artwork. |
|
inline |
Shows the PMI cross-highlighting setting.
out_state | Whether to highlight the geometry associated with a piece of PMI when that PMI is selected. |
|
inline |
Shows the semantic PMI information setting.
out_state | Whether to include semantic PMI information in the artwork. |
|
inline |
Shows the views for the artwork.
out_views | The views for the artwork. |
|
inline |
Removes the animation style setting.
|
inline |
Removes the default view preference setting.
|
inline |
Removes the display preference setting.
|
inline |
Removes all data from the artwork.
|
inline |
Removes the JavaScript setting.
|
inline |
Removes the PMI color setting from the artwork.
|
inline |
Removes the PMI cross-highlighting setting.
|
inline |
Removes the PMI semantic information setting.
|
inline |
Removes the view at the given index from the artwork.
in_index | Index of the view to remove from the artwork. |
|
inline |
Removes the views at the given indices from the artwork.
in_indices | Indices of the views to remove from the artwork. |
|
inline |
Removes all views from the artwork.