#include <PdfPublishAnimation.h>

Inheritance diagram for OdPdfPublish::OdAnimation:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdAnimation)

	ODRX_HEAP_OPERATORS ()

virtual	~OdAnimation ()

void	setName (const OdString &name)

void	setPlayOnOpenDocument (bool state)

void	setAutoReplay (bool state)

void	setFramesPerSecond (const OdUInt32 frame_per_second)

void	setFramesCount (const OdUInt64 frame_count)

void	setCameraMotion (const OdUInt64 &start_frame, const OdUInt64 &end_frame, OdBaseCameraMotionPtr motion)

void	addNodeMotion (const OdUInt64 &start_frame, const OdUInt64 &end_frame, OdBaseNodeMotionPtr motion)

void	getName (OdString &name) const

void	getPlayOnOpenDocument (bool &state) const

void	getAutoReplay (bool &state) const

void	getFramesPerSecond (OdUInt32 &frame_per_second) const

void	getFramesCount (OdUInt64 &frame_count) const

void	getCameraMotion (OdUInt64 &start_frame, OdUInt64 &end_frame, OdBaseCameraMotionPtr &motion) const

void	getNodeMotions (OdUInt64Array &starts_frame, OdUInt64Array &ends_frame, OdBaseNodeMotionPtrArray &motions) 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

Protected Member Functions
	OdAnimation ()

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

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

static OdRxClass *	desc ()

Detailed Description

This class implements a parametric animation object in .pdf documents created with Publish SDK.

Definition at line 50 of file PdfPublishAnimation.h.

Constructor & Destructor Documentation

◆ OdAnimation()

OdPdfPublish::OdAnimation::OdAnimation ( )

protected

◆ ~OdAnimation()

virtual OdPdfPublish::OdAnimation::~OdAnimation ( )

virtual

Destroys the animation object.

Member Function Documentation

◆ addNodeMotion()

void OdPdfPublish::OdAnimation::addNodeMotion	(	const OdUInt64 &	start_frame,
		const OdUInt64 &	end_frame,
		OdBaseNodeMotionPtr	motion
	)

Adds an object that handles a node motion when the animation is played.

Parameters

start_frame	[in] A start frame. Determines when the node motion starts.
end_frame	[in] An end frame. Determines when the node motion stops.
motion	[in] A smart pointer to a node motion object.

Remarks: The motion object should be an instance of a class inherited from the <link OdPdfPublish::OdBaseNodeMotion, OdBaseNodeMotion> class.

See also: <link OdPdfPublish::OdBaseNodeMotion, OdBaseNodeMotion>. <link OdPdfPublish::OdBaseCameraMotion, OdBaseCameraMotion>

◆ getAutoReplay()

void OdPdfPublish::OdAnimation::getAutoReplay ( bool & state ) const

Returns the current value of the flag that determines whether the animation should be replayed.

Parameters

state [out] A placeholder for the flag value.

Remarks: If the flag is true, the animation is replayed instantly, otherwise the animation stops when it is finished.

◆ getCameraMotion()

void OdPdfPublish::OdAnimation::getCameraMotion	(	OdUInt64 &	start_frame,
		OdUInt64 &	end_frame,
		OdBaseCameraMotionPtr &	motion
	)		const

Returns the current camera motion handler associated with the animation. The method fills passed values with the start frame index, end frame index and with a smart pointer to the camera motion object, then returns them to a calling subroutine.

Parameters

start_frame	[out] A placeholder for the camera motion start frame.
end_frame	[out] A placeholder for the camera motion end frame.
motion	[out] A placeholder for the smart pointer to the camera motion object.

See also: <link OdPdfPublish::OdBaseCameraMotion, OdBaseCameraMotion> <link OdPdfPublish::OdBaseNodeMotion, OdBaseNodeMotion>.

◆ getFramesCount()

void OdPdfPublish::OdAnimation::getFramesCount ( OdUInt64 & frame_count ) const

Returns the total frame quantity for the animation.

Parameters

frame_count [out] A placeholder for the total quantity of frames.

◆ getFramesPerSecond()

void OdPdfPublish::OdAnimation::getFramesPerSecond ( OdUInt32 & frame_per_second ) const

Returns the quantity of frames that are played per second during the animation.

Parameters

frame_per_second [out] A placeholder for the quantity of frames.

◆ getName()

void OdPdfPublish::OdAnimation::getName ( OdString & name ) const

Returns the name of the animation object.

Parameters

name	[out] A placeholder for the name of the animation.

◆ getNodeMotions()

void OdPdfPublish::OdAnimation::getNodeMotions	(	OdUInt64Array &	starts_frame,
		OdUInt64Array &	ends_frame,
		OdBaseNodeMotionPtrArray &	motions
	)		const

Returns all node motion handlers associated with the animation. The method fills the passed arrays with start and end frame numbers and with smart pointers to motion objects, then returns them to a calling subroutine.

Parameters

starts_frame	[out] A placeholder for motion start frames.
ends_frame	[out] A placeholder for motion end frames.
motions	[out] A placeholder for the array of node motion objects.

See also: <link OdPdfPublish::OdBaseNodeMotion, OdBaseNodeMotion>. <link OdPdfPublish::OdBaseCameraMotion, OdBaseCameraMotion>

◆ getPlayOnOpenDocument()

void OdPdfPublish::OdAnimation::getPlayOnOpenDocument ( bool & state ) const

Returns the current value of the flag that determines whether the animation should be started when a document opens.

Parameters

state [out] A placeholder for the flag value.

Remarks: If the flag is true, the animation starts after the document is opened, otherwise the animation starts on user request.

◆ ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdAnimation::ODRX_DECLARE_MEMBERS ( OdAnimation )

◆ ODRX_HEAP_OPERATORS()

OdPdfPublish::OdAnimation::ODRX_HEAP_OPERATORS ( )

◆ setAutoReplay()

void OdPdfPublish::OdAnimation::setAutoReplay ( bool state )

Sets the flag that determines whether the animation should be replayed.

Parameters

state [in] A new flag value.

Remarks: If the flag is true, the animation is replayed instantly, otherwise the animation stops when it is finished.

◆ setCameraMotion()

void OdPdfPublish::OdAnimation::setCameraMotion	(	const OdUInt64 &	start_frame,
		const OdUInt64 &	end_frame,
		OdBaseCameraMotionPtr	motion
	)

Sets an object that handles the camera motion when the animation is played.

Parameters

start_frame	[in] A start frame. Determines when the camera motion starts.
end_frame	[in] An end frame. Determines when the camera motion stops.
motion	[in] A smart pointer to a camera motion object.

Remarks: The motion object should be an instance of a class inherited from the <link OdPdfPublish::OdBaseCameraMotion, OdBaseCameraMotion> class. Note that for any animation, only one object of the OdBaseCameraMotion class can be set.

See also: <link OdPdfPublish::OdBaseCameraMotion, OdBaseCameraMotion> <link OdPdfPublish::OdBaseNodeMotion, OdBaseNodeMotion>.

◆ setFramesCount()

void OdPdfPublish::OdAnimation::setFramesCount ( const OdUInt64 frame_count )

Sets the total frame quantity for the animation.

Parameters

frame_count [in] A total quantity of frames.

◆ setFramesPerSecond()

void OdPdfPublish::OdAnimation::setFramesPerSecond ( const OdUInt32 frame_per_second )

Sets the quantity of frames that are played per second during the animation.

Parameters

frame_per_second [in] A quantity of frames.

◆ setName()

void OdPdfPublish::OdAnimation::setName ( const OdString & name )

Sets the name of the animation object.

Parameters

name	[in] A name of the animation.

◆ setPlayOnOpenDocument()

void OdPdfPublish::OdAnimation::setPlayOnOpenDocument ( bool state )

Sets the flag that determines whether the animation should be started when a document opens.

Parameters

state [in] A new flag value.

Remarks: If the flag is true, the animation starts after the document is opened, otherwise the animation starts on user request.

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

PdfPublishAnimation.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdAnimation()

◆ ~OdAnimation()

Member Function Documentation

◆ addNodeMotion()

◆ getAutoReplay()

◆ getCameraMotion()

◆ getFramesCount()

◆ getFramesPerSecond()

◆ getName()

◆ getNodeMotions()

◆ getPlayOnOpenDocument()

◆ ODRX_DECLARE_MEMBERS()

◆ ODRX_HEAP_OPERATORS()

◆ setAutoReplay()

◆ setCameraMotion()

◆ setFramesCount()

◆ setFramesPerSecond()

◆ setName()

◆ setPlayOnOpenDocument()