#include <PdfPublishArtwork.h>

Inheritance diagram for OdPdfPublish::OdArtwork:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdArtwork)

	ODRX_HEAP_OPERATORS ()

	OdArtwork ()

virtual	~OdArtwork ()

void	setAnimationStyle (Artwork::AnimationStyle style)

void	setJavaScript (const OdString &source)

void	setPMICrossHighlighting (bool state)

void	setPMISemanticInformation (bool state)

void	setDefaultViewPreference (Artwork::ViewPreference preference)

void	setDisplayPreference (Artwork::DisplayPreference preference)

void	addView (const OdViewPtr &view)

void	setPMIColor (ODCOLORREF pmi_color)

void	getAnimationStyle (Artwork::AnimationStyle &style) const

void	getJavaScript (OdString &source) const

void	getPMICrossHighlighting (bool &state) const

void	getPMISemanticInformation (bool &state) const

void	getDefaultViewPreference (Artwork::ViewPreference &preference) const

void	getDisplayPreference (Artwork::DisplayPreference &preference) const

void	getViews (OdViewPtrArray &views) const

void	getPMIColor (ODCOLORREF &pmi_color) const

Public Member Functions inherited from OdPdfPublish::OdObject
	ODRX_DECLARE_MEMBERS (OdObject)

	ODRX_HEAP_OPERATORS ()

virtual	~OdObject ()

virtual bool	isEmpty () const

virtual bool	isValid () const

virtual void	clear ()

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Protected Member Functions inherited from OdPdfPublish::OdObject
	OdObject (OdPublishObjectImpl *pImpl)

Detailed Description

This class implements an artwork entity for .pdf documents created with Teigha Publish. Artwork is a user space object that stores a set of object of different types (acts like a container for other objects and controls).

Definition at line 46 of file PdfPublishArtwork.h.

Constructor & Destructor Documentation

◆ OdArtwork()

OdPdfPublish::OdArtwork::OdArtwork ( )

Creates an artwork object.

◆ ~OdArtwork()

virtual OdPdfPublish::OdArtwork::~OdArtwork ( )

virtual

Destroys an artwork object.

Member Function Documentation

◆ addView()

void OdPdfPublish::OdArtwork::addView ( const OdViewPtr & view )

Add a new <link OdPdfPublish::OdView, view> to the artwork.

Parameters

view	[in] A smart pointer to a view that should be added.

See also: <link OdPdfPublish::OdView, View class>.

◆ getAnimationStyle()

void OdPdfPublish::OdArtwork::getAnimationStyle ( Artwork::AnimationStyle & style ) const

Returns current animation style of the artwork. The method fills a passed animation style and returns it to a calling subroutine.

Parameters

style [out] A placeholder for the animation style value.

See also: <link OdPdfPublish::Artwork::AnimationStyle, Artwork::AnimationStyle enumeration>.

◆ getDefaultViewPreference()

void OdPdfPublish::OdArtwork::getDefaultViewPreference ( Artwork::ViewPreference & preference ) const

Returns current source of preferred view options for the artwork. The method fills a passed options source value and returns it to a calling subroutine.

Parameters

preference [out] A placeholder for the source of preferred view options.

Remarks: View options can be taken from .prc or .pdf data (if such data exists).

See also: <link OdPdfPublish::Artwork::ViewPreference, Artwork::ViewPreference enumeration>.

◆ getDisplayPreference()

void OdPdfPublish::OdArtwork::getDisplayPreference ( Artwork::DisplayPreference & preference ) const

Returns current source of preferred display options for the artwork entity. The method fills a passed options source value and returns it to a calling subroutine.

Parameters

preference [out] A placeholder for the new source of preferred display options.

Remarks: Display options can be taken from a view options or from an application display settings.

See also: <link OdPdfPublish::Artwork::DisplayPreference, Artwork::DisplayPreference enumeration>.

◆ getJavaScript()

void OdPdfPublish::OdArtwork::getJavaScript ( OdString & source ) const

Returns current JavaScript scenario for the artwork. The method fills a passed string object with JavaScript scenario source code and returns it to a calling subroutine.

Parameters

source [out] A placeholder for the JavaScript scenario source code.

◆ getPMIColor()

void OdPdfPublish::OdArtwork::getPMIColor ( ODCOLORREF & pmi_color ) const

Returns current Picture Mastering Index color used by the artwork. The method fills a passed ODCOLORREF value and returns it to a calling subroutine.

Parameters

pmi_color [out] A a placeholder for the PMI color value.

◆ getPMICrossHighlighting()

void OdPdfPublish::OdArtwork::getPMICrossHighlighting ( bool & state ) const

Returns current value of the cross highlighting flag for the Picture Mastering Index (PMI) color. The method fills a passed boolean value and returns it to a calling subroutine.

Parameters

state [out] A placeholder for the PMI cross highlighting flag value.

Remarks: If the flag is set to true, the geometry related to a piece of PMI is hightlighted when the PMI is selected, otherwise is not.

◆ getPMISemanticInformation()

void OdPdfPublish::OdArtwork::getPMISemanticInformation ( bool & state ) const

Returns current value of the PMI semantic data flag. The method fills a passed boolean value and returns it to a calling subroutine.

Parameters

state [out] A placeholder for the value of PMI semantic data flag.

Remarks: If the flag is set to true, the artwork entity stores the semantic Picture Mastering Index data, otherwise it does not.

◆ getViews()

void OdPdfPublish::OdArtwork::getViews ( OdViewPtrArray & views ) const

Returns an array of artwork <link OdPdfPublish::OdView, views>. The method fills a passed view array object and returns it to a calling subroutine.

Parameters

views [out] A smart pointer to a view array that should be filled by the method.

See also: <link OdPdfPublish::OdView, OdView class>.

◆ ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdArtwork::ODRX_DECLARE_MEMBERS ( OdArtwork )

◆ ODRX_HEAP_OPERATORS()

OdPdfPublish::OdArtwork::ODRX_HEAP_OPERATORS ( )

◆ setAnimationStyle()

void OdPdfPublish::OdArtwork::setAnimationStyle ( Artwork::AnimationStyle style )

Sets an animation style of the artwork.

Parameters

style [in] A new animation style value.

See also: <link OdPdfPublish::Artwork::AnimationStyle, Artwork::AnimationStyle enumeration>.

◆ setDefaultViewPreference()

void OdPdfPublish::OdArtwork::setDefaultViewPreference ( Artwork::ViewPreference preference )

Sets preferred view options source for the artwork.

Parameters

preference [in] A new source of preferred view options.

Remarks: View options can be taken from .prc or .pdf data (if such data exists).

See also: <link OdPdfPublish::Artwork::ViewPreference, Artwork::ViewPreference enumeration>.

◆ setDisplayPreference()

void OdPdfPublish::OdArtwork::setDisplayPreference ( Artwork::DisplayPreference preference )

Sets the source of preferred display options for the artwork entity.

Parameters

preference [in] A new source of preferred display otpions.

Remarks: Display options can be taken from a view options or from an application display settings.

See also: <link OdPdfPublish::Artwork::DisplayPreference, Artwork::DisplayPreference>.

◆ setJavaScript()

void OdPdfPublish::OdArtwork::setJavaScript ( const OdString & source )

Sets a JavaScript scenario for the artwork.

Parameters

source [in] A string object that contains JavaScript scenario source code.

◆ setPMIColor()

void OdPdfPublish::OdArtwork::setPMIColor ( ODCOLORREF pmi_color )

Sets a Picture Mastering Index color used by the artwork.

Parameters

pmi_color [in] A a new PMI color value.

◆ setPMICrossHighlighting()

void OdPdfPublish::OdArtwork::setPMICrossHighlighting ( bool state )

Sets the cross highlighting flag for the Picture Mastering Index (PMI) color of the artwork entity. If the flag is set to true, the geometry related to a piece of PMI is hightlighted when the PMI is selected, otherwise is not.

Parameters

state [in] A new PMI cross highlighting flag value.

◆ setPMISemanticInformation()

void OdPdfPublish::OdArtwork::setPMISemanticInformation ( bool state )

Sets the semantic data flag for the Picture Mastering Index (PMI) of the artwork entity. If the flag is set to true, the artwork entity stores the semantic data, otherwise it does not.

Parameters

state [in] A new PMI semantic data flag value.

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

PdfPublishArtwork.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdArtwork()

◆ ~OdArtwork()

Member Function Documentation

◆ addView()

◆ getAnimationStyle()

◆ getDefaultViewPreference()

◆ getDisplayPreference()

◆ getJavaScript()

◆ getPMIColor()

◆ getPMICrossHighlighting()

◆ getPMISemanticInformation()

◆ getViews()

◆ ODRX_DECLARE_MEMBERS()

◆ ODRX_HEAP_OPERATORS()

◆ setAnimationStyle()

◆ setDefaultViewPreference()

◆ setDisplayPreference()

◆ setJavaScript()

◆ setPMIColor()

◆ setPMICrossHighlighting()

◆ setPMISemanticInformation()