KageProject Class Reference

#include <project.h>

Inheritance diagram for KageProject:

Collaboration diagram for KageProject:

Public Member Functions
std::string	toString ()
	KageProject (Kage *p_kage)
KageProject	operator= (const KageProject &p_project)
KageProject	operator= (const KageDocument &p_document)
void	init (Kage *p_kage)
virtual	~KageProject ()
void	renameLayer ()
void	renameScene ()
Public Member Functions inherited from KageDocument
	KageDocument ()
	KageDocument (KageDocument &p_document)
KageDocument	operator= (const KageDocument &p_document)
void	init ()
virtual	~KageDocument ()
unsigned int	openScene (std::string p_filepath)
bool	saveScene (unsigned int p_sceneID)
	Kage Document will contain several scenes. This will allow saving one Scene to be saved each time.
bool	openProject ()
bool	saveProject ()
bool	isSaved ()
unsigned int	addScene (std::string p_sceneLabel, bool p_asset=false)
	Used by Kage when creating new Scene, or opening KSF file (even if via KAGE file)
bool	removeAllScenes ()
bool	removeSceneAt (unsigned int p_sceneIndex)
	Used by KageDocument; This will gracefully remove all Layers of this Scene along with its Frames.
KageScene *	getScene ()
unsigned int	getCurrentScene ()
	returns activeSceneIndex+1; to get the actual (pointer to) Scene object, use getScene instead
void	setCurrentScene (unsigned int p_newScene)
	returns index+1
void	setCurrentSceneByID (unsigned int p_newSceneID)
unsigned int	getActiveSceneID ()
unsigned int	getActiveLayerID ()
unsigned int	getActiveFrameID ()
unsigned int	frameCount ()
void	setSceneLayerCurrentFrame (unsigned int p_frame)
std::string	getLayerLabel ()
void	setLayerLabel (std::string p_label)
void	toggleLayerVisibility ()
bool	isLayerVisible ()
void	setLayerVisible (bool p_visible)
void	toggleLayerLock ()
bool	isLayerLocked ()
void	setLayerLocked (bool p_lock)
bool	moveSceneUp ()
bool	moveSceneDown ()
bool	moveSceneToTop ()
bool	moveSceneToBottom ()
bool	gotoNextScene ()
	For use by Kage when Play is triggered.

Data Fields
std::string	_name
double	_width
double	_height
ColorData	_backgroundColor
unsigned int	_fps
Kage *	_kage
Data Fields inherited from KageDocument
bool	_saved
unsigned int	_activeSceneID
unsigned int	_activeSceneIndex
unsigned int	sceneCtr
unsigned int	_activeScene
	will be used to create Unique sceneCtr IDs
std::vector< Asset >	Assets
std::vector< KageScene * >	Scenes
KageScene *	_scenePtr

Additional Inherited Members
Public Types inherited from KageDocument
enum	AssetType { ASSET_IMAGE , ASSET_VIDEO , ASSET_KAGE }
Static Public Attributes inherited from KageDocument
static GdkPoint	_mouseLocation
static bool	_displayObjectIsShape
static bool	ASSET_MODE = false

Constructor & Destructor Documentation

KageProject()

KageProject::KageProject

(

Kage *

p_kage

)

Here is the call graph for this function:

Here is the caller graph for this function:

~KageProject()

KageProject::~KageProject ( )

virtual

Member Function Documentation

init()

void KageProject::init

(

Kage *

p_kage

)

Here is the call graph for this function:

operator=() [1/2]

KageProject KageProject::operator=

(

const KageDocument &

p_document

)

Here is the call graph for this function:

operator=() [2/2]

KageProject KageProject::operator=

(

const KageProject &

p_project

)

Here is the call graph for this function:

renameLayer()

void KageProject::renameLayer

(

)

For use of Kage when User clicked Layer->Rename

See also

renameLayer(KageLayer)

Here is the call graph for this function:

renameScene()

void KageProject::renameScene

(

)

For use of Kage when User clicked Scene->Rename

See also

renameScene(KageScenesUI)

Here is the call graph for this function:

toString()

std::string KageProject::toString

(

)

Here is the call graph for this function:

Field Documentation

_backgroundColor

ColorData KageProject::_backgroundColor

_fps

unsigned int KageProject::_fps

_height

double KageProject::_height

_kage

Kage* KageProject::_kage

_name

std::string KageProject::_name

_width

double KageProject::_width

---

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

• kage/project.h
• kage/project.cpp