#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::ArtworkKit:

Public Member Functions
ArtworkKit &	AddView (ViewKit const &in_view)

ArtworkKit &	AddViews (size_t in_count, ViewKit const in_views[])

ArtworkKit &	AddViews (ViewKitArray const &in_views)

	ArtworkKit ()

	ArtworkKit (ArtworkKit const &in_kit)

	ArtworkKit (ArtworkKit &&in_kit)

bool	Empty () const

bool	Equals (ArtworkKit const &in_kit) const

HPS::Type	ObjectType () const

bool	operator!= (ArtworkKit const &in_kit) const

ArtworkKit &	operator= (ArtworkKit const &in_kit)

ArtworkKit &	operator= (ArtworkKit &&in_kit)

bool	operator== (ArtworkKit const &in_kit) const

void	Set (ArtworkKit const &in_kit)

ArtworkKit &	SetAnimationStyle (Animation::Style in_style)

ArtworkKit &	SetDefaultViewPreference (Artwork::View::Preference in_preference)

ArtworkKit &	SetDisplayPreference (Artwork::Display::Preference in_preference)

ArtworkKit &	SetJavaScript (char const *in_source, Source::Type in_type=Source::Type::Code)

ArtworkKit &	SetPMIColor (HPS::RGBColor const &in_pmi_color)

ArtworkKit &	SetPMICrossHighlighting (bool in_state)

ArtworkKit &	SetPMISemanticInformation (bool in_state)

ArtworkKit &	SetView (ViewKit const &in_view)

ArtworkKit &	SetViews (size_t in_count, ViewKit const in_views[])

ArtworkKit &	SetViews (ViewKitArray const &in_views)

void	Show (ArtworkKit &out_kit) const

bool	ShowAnimationStyle (Animation::Style &out_style) const

bool	ShowDefaultViewPreference (Artwork::View::Preference &out_preference) const

bool	ShowDisplayPreference (Artwork::Display::Preference &out_preference) const

bool	ShowJavaScript (UTF8 &out_source, Source::Type &out_type) const

bool	ShowPMIColor (HPS::RGBColor &out_pmi_color) const

bool	ShowPMICrossHighlighting (bool &out_state) const

bool	ShowPMISemanticInformation (bool &out_state) const

bool	ShowViews (ViewKitArray &out_views) const

ArtworkKit &	UnsetAnimationStyle ()

ArtworkKit &	UnsetDefaultViewPreference ()

ArtworkKit &	UnsetDisplayPreference ()

ArtworkKit &	UnsetEverything ()

ArtworkKit &	UnsetJavaScript ()

ArtworkKit &	UnsetPMIColor ()

ArtworkKit &	UnsetPMICrossHighlighting ()

ArtworkKit &	UnsetPMISemanticInformation ()

ArtworkKit &	UnsetView (size_t in_index)

ArtworkKit &	UnsetViews (size_t in_count, size_t const in_indices[])

ArtworkKit &	UnsetViews (SizeTArray const &in_indices)

ArtworkKit &	UnsetViews ()

Public Member Functions inherited from HPS::Sprocket
	Sprocket (Sprocket &&in_that)

Public Member Functions inherited from HPS::Object
intptr_t	GetClassID () const

intptr_t	GetInstanceID () const

bool	HasType (HPS::Type in_mask) const

	Object (Object const &that)

	Object (Object &&in_that)

Object &	operator= (Object const &other_object)

Object &	operator= (Object &&in_that)

virtual void	Reset ()

virtual HPS::Type	Type () const

Static Public Member Functions
static ArtworkKit	GetDefault ()

Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t	ClassID ()

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::PublishArtworkKit

Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type	staticType = HPS::Type::SprocketKit

Static Public Attributes inherited from HPS::Object
static const HPS::Type	staticType = HPS::Type::None

Additional Inherited Members
Protected Member Functions inherited from HPS::SprocketKit
SprocketKit &	operator= (SprocketKit &&in_that)

	SprocketKit (SprocketKit &&in_that)

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/3]

HPS::Publish::ArtworkKit::ArtworkKit ( )

The default constructor creates an empty ArtworkKit object.

◆ ArtworkKit() [2/3]

HPS::Publish::ArtworkKit::ArtworkKit ( ArtworkKit const & in_kit )

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.

◆ ArtworkKit() [3/3]

HPS::Publish::ArtworkKit::ArtworkKit ( ArtworkKit && in_kit )

The move constructor creates an ArtworkKit by transferring the underlying object of the rvalue reference to this ArtworkKit.

Parameters

in_kit An rvalue reference to an ArtworkKit to take the underlying object from.

Member Function Documentation

◆ AddView()

ArtworkKit& HPS::Publish::ArtworkKit::AddView ( ViewKit const & 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.

Parameters

in_view The view to add to the artwork.

Returns: A reference to this ArtworkKit.

◆ AddViews() [1/2]

ArtworkKit& HPS::Publish::ArtworkKit::AddViews	(	size_t	in_count,
		ViewKit const	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.

Parameters

in_count	Size of the following array.
in_views	The views to add to the artwork.

Returns: A reference to this ArtworkKit.

◆ AddViews() [2/2]

ArtworkKit& HPS::Publish::ArtworkKit::AddViews ( ViewKitArray const & 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.

Parameters

in_views The views to add to the artwork.

Returns: A reference to this ArtworkKit.

◆ Empty()

bool HPS::Publish::ArtworkKit::Empty ( ) const

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.

◆ Equals()

bool HPS::Publish::ArtworkKit::Equals ( ArtworkKit const & in_kit ) const

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

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

◆ ObjectType()

HPS::Type HPS::Publish::ArtworkKit::ObjectType ( ) const

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.

◆ operator!=()

bool HPS::Publish::ArtworkKit::operator!= ( ArtworkKit const & in_kit ) const

Check if the source ArtworkKit is not equivalent to this ArtworkKit.

Parameters

in_kit The source ArtworkKit to compare to this ArtworkKit.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

ArtworkKit& HPS::Publish::ArtworkKit::operator= ( ArtworkKit const & in_kit )

Copies the source ArtworkKit into this ArtworkKit.

Parameters

in_kit The source ArtworkKit to copy.

Returns: A reference to this ArtworkKit.

◆ operator=() [2/2]

ArtworkKit& HPS::Publish::ArtworkKit::operator= ( ArtworkKit && in_kit )

The move assignment operator transfers the underlying object of the rvalue reference to this ArtworkKit.

Parameters

in_kit An rvalue reference to an ArtworkKit to take the underlying object from.

Returns: A reference to this ArtworkKit.

◆ operator==()

bool HPS::Publish::ArtworkKit::operator== ( ArtworkKit const & in_kit ) const

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.

◆ Set()

void HPS::Publish::ArtworkKit::Set ( ArtworkKit const & in_kit )

Copies the source ArtworkKit into this ArtworkKit.

Parameters

in_kit The source ArtworkKit to copy.

◆ SetAnimationStyle()

ArtworkKit& HPS::Publish::ArtworkKit::SetAnimationStyle ( Animation::Style in_style )

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

ArtworkKit& HPS::Publish::ArtworkKit::SetDefaultViewPreference ( 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.

Parameters

in_preference The default view preference for the artwork.

Returns: A reference to this ArtworkKit.

◆ SetDisplayPreference()

ArtworkKit& HPS::Publish::ArtworkKit::SetDisplayPreference ( 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.

Parameters

in_preference The display preference for the artwork.

Returns: A reference to this ArtworkKit.

◆ SetJavaScript()

ArtworkKit& HPS::Publish::ArtworkKit::SetJavaScript	(	char const *	in_source,
		Source::Type	in_type = `Source::Type::Code`
	)

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.

◆ SetPMIColor()

ArtworkKit& HPS::Publish::ArtworkKit::SetPMIColor ( HPS::RGBColor const & in_pmi_color )

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

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.

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

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.

Parameters

in_state Whether to include semantic PMI information in the artwork.

Returns: A reference to this ArtworkKit.

◆ SetView()

ArtworkKit& HPS::Publish::ArtworkKit::SetView ( ViewKit const & 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.

Parameters

in_view The view to add to the artwork.

Returns: A reference to this ArtworkKit.

◆ SetViews() [1/2]

ArtworkKit& HPS::Publish::ArtworkKit::SetViews	(	size_t	in_count,
		ViewKit const	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.

Parameters

in_count	Size of the following array.
in_views	The views to add to the artwork.

Returns: A reference to this ArtworkKit.

◆ SetViews() [2/2]

ArtworkKit& HPS::Publish::ArtworkKit::SetViews ( ViewKitArray const & 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.

Parameters

in_views The views to add to the artwork.

Returns: A reference to this ArtworkKit.

◆ Show()

void HPS::Publish::ArtworkKit::Show ( ArtworkKit & out_kit ) const

Copies this ArtworkKit into the given ArtworkKit.

Parameters

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

◆ ShowAnimationStyle()

bool HPS::Publish::ArtworkKit::ShowAnimationStyle ( Animation::Style & out_style ) const

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

bool HPS::Publish::ArtworkKit::ShowDefaultViewPreference ( Artwork::View::Preference & out_preference ) const

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

bool HPS::Publish::ArtworkKit::ShowDisplayPreference ( Artwork::Display::Preference & out_preference ) const

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

bool HPS::Publish::ArtworkKit::ShowJavaScript	(	UTF8 &	out_source,
		Source::Type &	out_type
	)		const

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 ( HPS::RGBColor & out_pmi_color ) const

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 ( bool & out_state ) const

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 ( bool & out_state ) const

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

bool HPS::Publish::ArtworkKit::ShowViews ( ViewKitArray & out_views ) const

Shows the views for the artwork.

Parameters

out_views The views for the artwork.

Returns: true if views were specified, false otherwise.

◆ UnsetAnimationStyle()

ArtworkKit& HPS::Publish::ArtworkKit::UnsetAnimationStyle ( )

Removes the animation style setting.

Returns: A reference to this ArtworkKit.

◆ UnsetDefaultViewPreference()

ArtworkKit& HPS::Publish::ArtworkKit::UnsetDefaultViewPreference ( )

Removes the default view preference setting.

Returns: A reference to this ArtworkKit.

◆ UnsetDisplayPreference()

ArtworkKit& HPS::Publish::ArtworkKit::UnsetDisplayPreference ( )

Removes the display preference setting.

Returns: A reference to this ArtworkKit.

◆ UnsetEverything()

ArtworkKit& HPS::Publish::ArtworkKit::UnsetEverything ( )

Removes all data from the artwork.

Returns: A reference to this ArtworkKit.

◆ UnsetJavaScript()

ArtworkKit& HPS::Publish::ArtworkKit::UnsetJavaScript ( )

Removes the JavaScript setting.

Returns: A reference to this ArtworkKit.

◆ UnsetPMIColor()

ArtworkKit& HPS::Publish::ArtworkKit::UnsetPMIColor ( )

Removes the PMI color setting from the artwork.

Returns: A reference to this ArtworkKit.

◆ UnsetPMICrossHighlighting()

ArtworkKit& HPS::Publish::ArtworkKit::UnsetPMICrossHighlighting ( )

Removes the PMI cross-highlighting setting.

Returns: A reference to this ArtworkKit.

◆ UnsetPMISemanticInformation()

ArtworkKit& HPS::Publish::ArtworkKit::UnsetPMISemanticInformation ( )

Removes the PMI semantic information setting.

Returns: A reference to this ArtworkKit.

◆ UnsetView()

ArtworkKit& HPS::Publish::ArtworkKit::UnsetView ( size_t in_index )

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/3]

ArtworkKit& HPS::Publish::ArtworkKit::UnsetViews	(	size_t	in_count,
		size_t const	in_indices[]
	)

Removes the views at the given indices from the artwork.

Parameters

in_count	Size of the following array.
in_indices	Indices of the views to remove from the artwork.

Returns: A reference to this ArtworkKit.

◆ UnsetViews() [2/3]

ArtworkKit& HPS::Publish::ArtworkKit::UnsetViews ( SizeTArray const & in_indices )

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() [3/3]

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:

include/sprk_publish.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ArtworkKit() [1/3]

◆ ArtworkKit() [2/3]

◆ ArtworkKit() [3/3]

Member Function Documentation

◆ AddView()

◆ AddViews() [1/2]

◆ AddViews() [2/2]

◆ Empty()

◆ Equals()

◆ GetDefault()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Set()

◆ SetAnimationStyle()

◆ SetDefaultViewPreference()

◆ SetDisplayPreference()

◆ SetJavaScript()

◆ SetPMIColor()

◆ SetPMICrossHighlighting()

◆ SetPMISemanticInformation()

◆ SetView()

◆ SetViews() [1/2]

◆ SetViews() [2/2]

◆ Show()

◆ ShowAnimationStyle()

◆ ShowDefaultViewPreference()

◆ ShowDisplayPreference()

◆ ShowJavaScript()

◆ ShowPMIColor()

◆ ShowPMICrossHighlighting()

◆ ShowPMISemanticInformation()

◆ ShowViews()

◆ UnsetAnimationStyle()

◆ UnsetDefaultViewPreference()

◆ UnsetDisplayPreference()

◆ UnsetEverything()

◆ UnsetJavaScript()

◆ UnsetPMIColor()

◆ UnsetPMICrossHighlighting()

◆ UnsetPMISemanticInformation()

◆ UnsetView()

◆ UnsetViews() [1/3]

◆ UnsetViews() [2/3]

◆ UnsetViews() [3/3]