IPageTransition Class Reference

#include <IPageTransition.h>

Inheritance diagram for IPageTransition:

Public Types
enum	{ kDefaultIID = IID_IPAGETRANSITION }
enum	PageTransitionDirection {   kNA = 0, kDown, kLeft, kLeftDown,   kLeftUp, kRight, kRightDown, kRightUp,   kUp, kIn, kOut, kHorizontal,   kVertical, kHorizontalIn, kHorizontalOut, kVerticalIn,   kVerticalOut }

Public Member Functions
virtual PMString	GetName (bool bTranslateName=false) const =0
virtual uint32	GetDefaultDuration () const =0
virtual uint32	GetDefaultDirection () const =0
virtual uint32	GetNumberOfDirections () const =0
virtual uint32	GetNthDirection (uint32 index) const =0
virtual IDFile	GetSWFStaticRepresentation () const =0
virtual void	GetSWFDynamicRepresentation (uint32 const &direction, uint32 const &duration, IDFile &localFile) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Static Public Attributes
static const uint32	kPageTransitionsSlowSpeedTime = 60
static const uint32	kPageTransitionsMediumSpeedTime = 40
static const uint32	kPageTransitionsFastSpeedTime = 20
static const uint32	kDefaultDurationTime = kPageTransitionsMediumSpeedTime

Detailed Description

This interface is on every page transion object.

See Also

kBlindsPageTransitionBoss

kBoxPageTransitionBoss

kCombPageTransitionBoss

kCoverPageTransitionBoss

kDissolvePageTransitionBoss

kFadePageTransitionBoss

kPageTurnPageTransitionBoss

kPushPageTransitionBoss

kSplitPageTransitionBoss

kUncoverPageTransitionBoss

kWipePageTransitionBoss

kZoomInPageTransitionBoss

kZoomOutPageTransitionBoss

It is used to obtain page transition's properties such as name, duration and direciton.

Member Enumeration Documentation

enum IPageTransition::PageTransitionDirection

Directions for page transitions. Some page transitions support a directional component.

Member Function Documentation

virtual uint32 IPageTransition::GetDefaultDirection ( ) const

pure virtual

Gets the default direction for the page transition.

Returns

uint32 The default direction of the page transition, as defined in the enum above.

virtual uint32 IPageTransition::GetDefaultDuration ( ) const

pure virtual

Gets the default duration time of the page transition.

Returns

uint32 The default duration of the page transition in ticks - 60 ticks per seconds.

virtual PMString IPageTransition::GetName ( bool  bTranslateName = false ) const

pure virtual

Gets the name of the page transition.

Parameters

bTranslateName

If kTrue, the returned name will be translated

Returns

PMString Containing the page transition name.

virtual uint32 IPageTransition::GetNthDirection ( uint32  index ) const

pure virtual

Gets the nth direction the page transition supports.

Returns

uint32 The nth direction of the page transition, as defined in the enum above.

virtual uint32 IPageTransition::GetNumberOfDirections ( ) const

pure virtual

Gets the number directions the page transition supports.

Returns

uint32 The number of directions the page transition supports.

virtual void IPageTransition::GetSWFDynamicRepresentation ( uint32 const &  direction, uint32 const &  duration, IDFile &  localFile  ) const

pure virtual

Gets an IDFile that is a SWF showing a proxy representation of the page transition based on the given direction and duration.

Parameters

direction	[IN]: given direction for the page transition.
duration	[IN]: given duration for the page transtion (duration is represented as kPageTransitionsSlowSpeedTime, kPageTransitionsMediumSpeedTime, kPageTransitionsFastSpeedTime)
localFile	[OUT]: the swf file based on the given direction and duration.

virtual IDFile IPageTransition::GetSWFStaticRepresentation ( ) const

pure virtual

Gets an IDFile that is a SWF showing a proxy representation of the page transition.

Returns

IDFile A SWF proxy representation of the page transition.

Member Data Documentation

const uint32 IPageTransition::kPageTransitionsSlowSpeedTime = 60

static

The default page transition duration time, in ticks (every second is 60 ticks)