|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ ArtworkKit() [1/2]
HPS.Publish.ArtworkKit.ArtworkKit |
( |
| ) |
|
|
inline |
The default constructor creates an empty ArtworkKit object.
◆ ArtworkKit() [2/2]
The copy constructor creates a new ArtworkKit object that contains the same settings as the source ArtworkKit.
- Parameters
-
◆ AddView()
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()
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()
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()
Check if the source ArtworkKit is equivalent to this ArtworkKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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.
- 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()
◆ SetAnimationStyle()
◆ SetDefaultViewPreference()
◆ SetDisplayPreference()
◆ SetJavaScript() [1/2]
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]
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()
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()
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()
◆ SetView()
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()
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()
◆ ShowAnimationStyle()
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()
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()
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()
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()
bool HPS.Publish.ArtworkKit.ShowPMIColor |
( |
out HPS.RGBColor |
out_pmi_color | ) |
|
|
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()
bool HPS.Publish.ArtworkKit.ShowPMICrossHighlighting |
( |
out bool |
out_state | ) |
|
|
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()
bool HPS.Publish.ArtworkKit.ShowPMISemanticInformation |
( |
out bool |
out_state | ) |
|
|
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()
Shows the views for the artwork.
- Parameters
-
out_views | The views for the artwork. |
- Returns
- true if views were specified, false otherwise.
◆ UnsetAnimationStyle()
Removes the animation style setting.
- Returns
- A reference to this ArtworkKit.
◆ UnsetDefaultViewPreference()
Removes the default view preference setting.
- Returns
- A reference to this ArtworkKit.
◆ UnsetDisplayPreference()
Removes the display preference setting.
- Returns
- A reference to this ArtworkKit.
◆ UnsetEverything()
Removes all data from the artwork.
- Returns
- A reference to this ArtworkKit.
◆ UnsetJavaScript()
Removes the JavaScript setting.
- Returns
- A reference to this ArtworkKit.
◆ UnsetPMIColor()
Removes the PMI color setting from the artwork.
- Returns
- A reference to this ArtworkKit.
◆ UnsetPMICrossHighlighting()
Removes the PMI cross-highlighting setting.
- Returns
- A reference to this ArtworkKit.
◆ UnsetPMISemanticInformation()
Removes the PMI semantic information setting.
- Returns
- A reference to this ArtworkKit.
◆ UnsetView()
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]
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]
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