KageFrameset Class Reference

#include <frameset.h>

Inheritance diagram for KageFrameset:

Collaboration diagram for KageFrameset:

Public Member Functions
	KageFrameset (KageFramesetManager *p_fsm, unsigned int p_layerID, unsigned int p_frameCount)
virtual	~KageFrameset ()
unsigned int	getID ()
bool	selectAll (bool p_selectAll)
unsigned int	getFrameCount ()
bool	addFrame ()
void	duplicateFrame ()
void	extendFrame ()
bool	removeFrame ()
unsigned int	getCurrentFrame ()
void	setCurrentFrame (unsigned int p_frame)
void	setCurrentFrameByID (unsigned int p_frameID)
void	focusFrame (unsigned int p_frame)
void	removeAllFrames ()
KageFramesetManager *	getFsm ()
KageFrame *	getFrameAt (unsigned int p_frame)
unsigned int	getFrameNumberByID (unsigned int p_frameID)
void	setSelected (KageFrame *p_frame)
vector< unsigned int >	raiseSelectedShape (vector< unsigned int > p_selectedShapes)
vector< unsigned int >	lowerSelectedShape (vector< unsigned int > p_selectedShapes)
vector< unsigned int >	raiseToTopSelectedShape (vector< unsigned int > p_selectedShapes)
vector< unsigned int >	lowerToBottomSelectedShape (vector< unsigned int > p_selectedShapes)
vector< unsigned int >	groupSelectedShapes (vector< unsigned int > p_selectedShapes)
vector< unsigned int >	ungroupSelectedShapes (vector< unsigned int > p_selectedShapes)
vector< unsigned int >	duplicateShapes (vector< unsigned int > p_selectedShapes)
bool	flipHorizontalSelectedShape (vector< unsigned int > p_selectedShapes)
bool	flipVerticalSelectedShape (vector< unsigned int > p_selectedShapes)
bool	doFlipVerticalSelectedShapeOn (unsigned int p_frameIndex, vector< unsigned int > p_selectedShapes)
bool	doFlipVerticalSelectedShapeOnExtendedFrame (unsigned int p_frameIndex, vector< unsigned int > p_selectedShapes)
bool	recenterRotationPoint (vector< unsigned int > p_selectedShapes)
bool	addDataToFrame (VectorDataManager p_vectorsData)
bool	setFrameData (VectorDataManager p_vectorsData)
VectorDataManager	getFrameTweenData (unsigned int p_frameIndex)
VectorDataManager	getFrameData ()
VectorDataManager	getFrameDataAt (unsigned int p_frame)
VectorDataManager	getPreviousFrameData (unsigned int p_frameID)
	NOTE: "Frame" – NOT "frame ID".
bool	setFrameDataToPreviousFrame (VectorDataManager p_vectorsData, unsigned int p_frameID)
	Called by KageFrame if KageFrame is Extended.
bool	addDataToPreviousFrame (VectorDataManager v, unsigned int p_frameID)
	Called by KageFrame if KageFrame is Extended.
bool	setPreviousFrameTween (unsigned int p_frameID, unsigned int p_tween)
	Called by KageFrame if KageFrame is Extended.
bool	setExtendedFrameTween (unsigned int p_frameID, unsigned int p_tween)
bool	forceSetTween (unsigned int p_tween)
bool	setTween (unsigned int p_tween)
unsigned int	getTween ()
bool	switchToPreviousFrame ()
bool	switchToPreviousFrame (unsigned int p_frameID)
	Called by FrameSet for navigating to Previous Frame.
bool	switchToNextFrame ()
	Called by KageFrame for navigating to Previous Frame.
bool	switchToNextFrame (unsigned int p_frameID)
	Called by FrameSet for navigating to Next Frame.
bool	isCurrentFrame (unsigned int p_frameID)
	Called by KageFrame for navigating to Next Frame.
bool	canReUseNextFrame ()
	Called by KageFrame when rendering.
void	setFrameExtension (KageFrame::extension p_extension)
	Called by KageFramesetManager when duplicating Frame.

Protected Member Functions
bool	moveToLeft ()
bool	moveToLeftAt (unsigned int p_frame)
	Moves Current Frame to Left.
bool	moveToLeftMost ()
	Moves Current Frame to Left on indicated Frame.

Protected Attributes
unsigned int	layerID
unsigned int	frameCtr
std::vector< KageFrame * >	_frames
KageFramePadding	frame_padding
KageFramesetManager *	fsm
unsigned int	_currentFrameID
unsigned int	_currentFrameIndex

Constructor & Destructor Documentation

KageFrameset()

KageFrameset::KageFrameset	(	KageFramesetManager *	p_fsm,
		unsigned int	p_layerID,
		unsigned int	p_frameCount
	)

Here is the call graph for this function:

~KageFrameset()

KageFrameset::~KageFrameset ( )

virtual

Member Function Documentation

addDataToFrame()

bool KageFrameset::addDataToFrame

(

VectorDataManager

p_vectorsData

)

Here is the call graph for this function:

addDataToPreviousFrame()

bool KageFrameset::addDataToPreviousFrame	(	VectorDataManager	v,
		unsigned int	p_frameID
	)

Called by KageFrame if KageFrame is Extended.

Here is the call graph for this function:

Here is the caller graph for this function:

addFrame()

bool KageFrameset::addFrame

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

canReUseNextFrame()

bool KageFrameset::canReUseNextFrame

(

)

Called by KageFrame when rendering.

doFlipVerticalSelectedShapeOn()

bool KageFrameset::doFlipVerticalSelectedShapeOn	(	unsigned int	p_frameIndex,
		vector< unsigned int >	p_selectedShapes
	)

Here is the call graph for this function:

Here is the caller graph for this function:

doFlipVerticalSelectedShapeOnExtendedFrame()

bool KageFrameset::doFlipVerticalSelectedShapeOnExtendedFrame	(	unsigned int	p_frameIndex,
		vector< unsigned int >	p_selectedShapes
	)

Here is the caller graph for this function:

duplicateFrame()

void KageFrameset::duplicateFrame

(

)

Here is the call graph for this function:

duplicateShapes()

vector< unsigned int > KageFrameset::duplicateShapes

(

vector< unsigned int >

p_selectedShapes

)

Here is the call graph for this function:

extendFrame()

void KageFrameset::extendFrame

(

)

Here is the call graph for this function:

flipHorizontalSelectedShape()

bool KageFrameset::flipHorizontalSelectedShape

(

vector< unsigned int >

p_selectedShapes

)

Here is the call graph for this function:

flipVerticalSelectedShape()

bool KageFrameset::flipVerticalSelectedShape

(

vector< unsigned int >

p_selectedShapes

)

Here is the call graph for this function:

focusFrame()

void KageFrameset::focusFrame

(

unsigned int

p_frame

)

Here is the call graph for this function:

Here is the caller graph for this function:

forceSetTween()

bool KageFrameset::forceSetTween

(

unsigned int

p_tween

)

Here is the call graph for this function:

getCurrentFrame()

unsigned int KageFrameset::getCurrentFrame

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

getFrameAt()

KageFrame * KageFrameset::getFrameAt

(

unsigned int

p_frame

)

Here is the call graph for this function:

Here is the caller graph for this function:

getFrameCount()

unsigned int KageFrameset::getFrameCount

(

)

Here is the caller graph for this function:

getFrameData()

VectorDataManager KageFrameset::getFrameData

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

getFrameDataAt()

VectorDataManager KageFrameset::getFrameDataAt

(

unsigned int

p_frame

)

Here is the call graph for this function:

getFrameNumberByID()

unsigned int KageFrameset::getFrameNumberByID

(

unsigned int

p_frameID

)

Here is the call graph for this function:

getFrameTweenData()

VectorDataManager KageFrameset::getFrameTweenData

(

unsigned int

p_frameIndex

)

Here is the call graph for this function:

Here is the caller graph for this function:

getFsm()

KageFramesetManager * KageFrameset::getFsm

(

)

Here is the caller graph for this function:

getID()

unsigned int KageFrameset::getID

(

)

getPreviousFrameData()

VectorDataManager KageFrameset::getPreviousFrameData

(

unsigned int

p_frameID

)

NOTE: "Frame" – NOT "frame ID".

Here is the call graph for this function:

Here is the caller graph for this function:

getTween()

unsigned int KageFrameset::getTween

(

)

Here is the call graph for this function:

groupSelectedShapes()

vector< unsigned int > KageFrameset::groupSelectedShapes

(

vector< unsigned int >

p_selectedShapes

)

Here is the call graph for this function:

isCurrentFrame()

bool KageFrameset::isCurrentFrame

(

unsigned int

p_frameID

)

Called by KageFrame for navigating to Next Frame.

Here is the caller graph for this function:

lowerSelectedShape()

vector< unsigned int > KageFrameset::lowerSelectedShape

(

vector< unsigned int >

p_selectedShapes

)

Here is the call graph for this function:

lowerToBottomSelectedShape()

vector< unsigned int > KageFrameset::lowerToBottomSelectedShape

(

vector< unsigned int >

p_selectedShapes

)

Here is the call graph for this function:

moveToLeft()

bool KageFrameset::moveToLeft ( )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

moveToLeftAt()

bool KageFrameset::moveToLeftAt ( unsigned int  p_frame )

protected

Moves Current Frame to Left.

Here is the call graph for this function:

moveToLeftMost()

bool KageFrameset::moveToLeftMost ( )

protected

Moves Current Frame to Left on indicated Frame.

Here is the call graph for this function:

raiseSelectedShape()

vector< unsigned int > KageFrameset::raiseSelectedShape

(

vector< unsigned int >

p_selectedShapes

)

Here is the call graph for this function:

raiseToTopSelectedShape()

vector< unsigned int > KageFrameset::raiseToTopSelectedShape

(

vector< unsigned int >

p_selectedShapes

)

Here is the call graph for this function:

recenterRotationPoint()

bool KageFrameset::recenterRotationPoint

(

vector< unsigned int >

p_selectedShapes

)

Here is the call graph for this function:

removeAllFrames()

void KageFrameset::removeAllFrames

(

)

Here is the call graph for this function:

removeFrame()

bool KageFrameset::removeFrame

(

)

If KageFrame is NULL or Last Frame (but not Frame-index0), remove Frame Widget, else, do below steps.

1. Copy content of Frame+1 to Frame+0; then make Frame+1 as Frame+0
2. If Frame+0 is not Last Frame, repeat 1
3. Set last Frame = NULL

Returns

True if Last Frame widget was removed

Here is the call graph for this function:

selectAll()

bool KageFrameset::selectAll

(

bool

p_selectAll

)

Here is the call graph for this function:

setCurrentFrame()

void KageFrameset::setCurrentFrame

(

unsigned int

p_frame

)

For use of Kage. When a KageLayer is clicked, KageLayerManager will call this function via Kage then sets currently active Frame along Layer

Parameters

p_frame

is Frame Number known to KageFrame(/Layer?)

See also

getCurrentFrame()

Here is the call graph for this function:

Here is the caller graph for this function:

setCurrentFrameByID()

void KageFrameset::setCurrentFrameByID

(

unsigned int

p_frameID

)

setExtendedFrameTween()

bool KageFrameset::setExtendedFrameTween	(	unsigned int	p_frameID,
		unsigned int	p_tween
	)

Here is the call graph for this function:

Here is the caller graph for this function:

setFrameData()

bool KageFrameset::setFrameData

(

VectorDataManager

p_vectorsData

)

Here is the call graph for this function:

Here is the caller graph for this function:

setFrameDataToPreviousFrame()

bool KageFrameset::setFrameDataToPreviousFrame	(	VectorDataManager	p_vectorsData,
		unsigned int	p_frameID
	)

Called by KageFrame if KageFrame is Extended.

Here is the call graph for this function:

Here is the caller graph for this function:

setFrameExtension()

void KageFrameset::setFrameExtension

(

KageFrame::extension

p_extension

)

Called by KageFramesetManager when duplicating Frame.

For use of Kage when loading KSF file

Parameters

p_extension

if start/mid/end of frame extension

Here is the call graph for this function:

setPreviousFrameTween()

bool KageFrameset::setPreviousFrameTween	(	unsigned int	p_frameID,
		unsigned int	p_tween
	)

Called by KageFrame if KageFrame is Extended.

Here is the call graph for this function:

Here is the caller graph for this function:

setSelected()

void KageFrameset::setSelected

(

KageFrame *

p_frame

)

For use of KageFrame. When a KageFrame is clicked, previously clicked KageFrame should be un-selected.

Parameters

p_frame

is pointer to KageFrame who called this function

Here is the call graph for this function:

Here is the caller graph for this function:

setTween()

bool KageFrameset::setTween

(

unsigned int

p_tween

)

Here is the call graph for this function:

switchToNextFrame() [1/2]

bool KageFrameset::switchToNextFrame

(

)

Called by KageFrame for navigating to Previous Frame.

index + 1 = becomes frameNumber for current. then +1 becomes frameNumber of Next Frame

Here is the call graph for this function:

Here is the caller graph for this function:

switchToNextFrame() [2/2]

bool KageFrameset::switchToNextFrame

(

unsigned int

p_frameID

)

Called by FrameSet for navigating to Next Frame.

index + 1 = becomes frameNumber for current. then +1 becomes frameNumber of Next Frame

Here is the call graph for this function:

switchToPreviousFrame() [1/2]

bool KageFrameset::switchToPreviousFrame

(

)

index + 1 = becomes frameNumber for current. then -1 becomes frameNumber of Previous Frame; thus ‘setCurrentFrame(i)’

Here is the call graph for this function:

Here is the caller graph for this function:

switchToPreviousFrame() [2/2]

bool KageFrameset::switchToPreviousFrame

(

unsigned int

p_frameID

)

Called by FrameSet for navigating to Previous Frame.

index + 1 = becomes frameNumber for current. then -1 becomes frameNumber of Previous Frame; thus ‘setCurrentFrame(i)’

Here is the call graph for this function:

ungroupSelectedShapes()

vector< unsigned int > KageFrameset::ungroupSelectedShapes

(

vector< unsigned int >

p_selectedShapes

)

Here is the call graph for this function:

Field Documentation

_currentFrameID

unsigned int KageFrameset::_currentFrameID

protected

_currentFrameIndex

unsigned int KageFrameset::_currentFrameIndex

protected

_frames

std::vector<KageFrame*> KageFrameset::_frames

protected

frame_padding

KageFramePadding KageFrameset::frame_padding

protected

frameCtr

unsigned int KageFrameset::frameCtr

protected

fsm

KageFramesetManager* KageFrameset::fsm

protected

layerID

unsigned int KageFrameset::layerID

protected

---

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

• kage/timeline/frameset.h
• kage/timeline/frameset.cpp