
Public Member 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. 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 A3DPDF3DArtworkAddView. 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 (if the object is derived, this does not give the true type of the derived object). 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. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_eAnimationStyle. 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 A3DPDF3DArtworkData::m_bKeepNativeDefaultView. 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 A3DPDF3DArtworkData::m_bUseRuntimeDisplaySettings. 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 A3DPDF3DArtworkData::m_pcJavaScriptFileName. 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 A3DPDF3DArtworkData::m_pcJavaScriptFileName. 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 A3DPDF3DArtworkData::m_sPMIColor . 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 A3DPDF3DArtworkData::m_bActivatePMICrossHighlight. 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 A3DPDF3DArtworkData::m_bAddPMISemanticInformation. 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 A3DPDF3DArtworkAddView. 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 A3DPDF3DArtworkAddView. 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... | |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual 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... | |
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 | |
![]() | |
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]
|
inline |
The default constructor creates an empty ArtworkKit object.
◆ ArtworkKit() [2/2]
|
inline |
The copy constructor creates a new ArtworkKit object that contains the same settings as the source ArtworkKit.
- Parameters
-
in_kit The source ArtworkKit to copy.
Member Function Documentation
◆ AddView()
|
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_view The view to add to the artwork.
- Returns
- A reference to this ArtworkKit.
◆ AddViews()
|
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_views The views to add to the artwork.
- Returns
- A reference to this 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()
|
inline |
Check if the source ArtworkKit is equivalent to this ArtworkKit.
- Parameters
-
in_kit The source ArtworkKit to compare to this ArtworkKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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()
|
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()
|
inline |
Copies the source ArtworkKit into this ArtworkKit.
- Parameters
-
in_kit The source ArtworkKit to copy.
◆ SetAnimationStyle()
|
inline |
Sets the animation style for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_eAnimationStyle.
- Parameters
-
in_style The animation style for the artwork.
- Returns
- A reference to this ArtworkKit.
◆ SetDefaultViewPreference()
|
inline |
Sets the default view preference for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_bKeepNativeDefaultView.
- Parameters
-
in_preference The default view preference for the artwork.
- Returns
- A reference to this ArtworkKit.
◆ SetDisplayPreference()
|
inline |
Sets the display preference for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_bUseRuntimeDisplaySettings.
- Parameters
-
in_preference The display preference for the artwork.
- Returns
- A reference to this ArtworkKit.
◆ SetJavaScript() [1/2]
|
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_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.
- Returns
- A reference to this ArtworkKit.
◆ SetJavaScript() [2/2]
|
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_source The JavaScript source or file (depending on the next argument) for the artwork.
- Returns
- A reference to this ArtworkKit.
◆ SetPMIColor()
|
inline |
Sets the PMI color for this artwork. This correspond to value that will be passed to A3DPDF3DArtworkData::m_sPMIColor .
- Parameters
-
in_pmi_color The color to apply to PMIs for this artwork.
- Returns
- A reference to this ArtworkKit.
◆ SetPMICrossHighlighting()
|
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_state Whether to highlight the geometry associated with a piece of PMI when that PMI is selected.
- Returns
- A reference to this ArtworkKit.
◆ SetPMISemanticInformation()
|
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_state Whether to include semantic PMI information in the artwork.
- Returns
- A reference to this ArtworkKit.
◆ SetView()
|
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_view The view to add to the artwork.
- Returns
- A reference to this ArtworkKit.
◆ SetViews()
|
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_views The views to add to the artwork.
- Returns
- A reference to this ArtworkKit.
◆ Show()
|
inline |
Copies this ArtworkKit into the given ArtworkKit.
- Parameters
-
out_kit The ArtworkKit to populate with the contents of this ArtworkKit.
◆ ShowAnimationStyle()
|
inline |
Shows the animation style setting.
- Parameters
-
out_style The animation style of the artwork.
- Returns
- true if an animation style was specified, false otherwise.
◆ ShowDefaultViewPreference()
|
inline |
Shows the default view preference setting.
- Parameters
-
out_preference The default view preference for the artwork.
- Returns
- true if a default view preference was specified, false otherwise.
◆ ShowDisplayPreference()
|
inline |
Shows the display preference setting.
- Parameters
-
out_preference The display preference for the artwork.
- Returns
- true if a display preference was specified, false otherwise.
◆ ShowJavaScript()
|
inline |
Shows the JavaScript setting.
- Parameters
-
out_source The JavaScript source or file (depending on the next argument) for the artwork. out_type The type of the preceding argument.
- Returns
- true if a JavaScript source or file was specified, false otherwise.
◆ ShowPMIColor()
|
inline |
Shows the PMI color for the artwork.
- Parameters
-
out_pmi_color The PMI color for the artwork.
- Returns
- true if a PMI color was specified, false otherwise.
◆ ShowPMICrossHighlighting()
|
inline |
Shows the PMI cross-highlighting setting.
- Parameters
-
out_state Whether 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()
|
inline |
Shows the semantic PMI information setting.
- Parameters
-
out_state Whether to include semantic PMI information in the artwork.
- Returns
- true if a semantic PMI information setting was specified, false otherwise.
◆ ShowViews()
|
inline |
Shows the views for the artwork.
- Parameters
-
out_views The views for the artwork.
- Returns
- true if views were specified, false otherwise.
◆ UnsetAnimationStyle()
|
inline |
Removes the animation style setting.
- Returns
- A reference to this ArtworkKit.
◆ UnsetDefaultViewPreference()
|
inline |
Removes the default view preference setting.
- Returns
- A reference to this ArtworkKit.
◆ UnsetDisplayPreference()
|
inline |
Removes the display preference setting.
- Returns
- A reference to this ArtworkKit.
◆ UnsetEverything()
|
inline |
Removes all data from the artwork.
- Returns
- A reference to this ArtworkKit.
◆ UnsetJavaScript()
|
inline |
Removes the JavaScript setting.
- Returns
- A reference to this ArtworkKit.
◆ UnsetPMIColor()
|
inline |
Removes the PMI color setting from the artwork.
- Returns
- A reference to this ArtworkKit.
◆ UnsetPMICrossHighlighting()
|
inline |
Removes the PMI cross-highlighting setting.
- Returns
- A reference to this ArtworkKit.
◆ UnsetPMISemanticInformation()
|
inline |
Removes the PMI semantic information setting.
- Returns
- A reference to this ArtworkKit.
◆ UnsetView()
|
inline |
Removes the view at the given index from the artwork.
- Parameters
-
in_index Index of the view to remove from the artwork.
- Returns
- A reference to this ArtworkKit.
◆ UnsetViews() [1/2]
|
inline |
Removes the views at the given indices from the artwork.
- Parameters
-
in_indices Indices of the views to remove from the artwork.
- Returns
- A reference to this ArtworkKit.
◆ UnsetViews() [2/2]
|
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