#include <arealayout.h>

Inheritance diagram for Engines::Jade::AreaLayout:

Collaboration diagram for Engines::Jade::AreaLayout:

[legend]

Public Member Functions
	AreaLayout (const Common::UString &resRef)

virtual	~AreaLayout ()

const Common::UString &	getResRef ()
	Return the area's resref (resource ID). More...

virtual void	show ()

virtual void	hide ()

void	updateCamera ()

Protected Member Functions
	AreaLayout ()

virtual void	clear ()

virtual void	load ()

virtual void	loadResources ()

Protected Attributes
Common::UString	_resRef
	The area's resref (resource ID). More...

Common::UString	_layout
	The area's layout resref (resource ID). More...

std::list< Common::ChangeID >	_resources
	The area's resource archives. More...

bool	_visible
	Is the area currently visible? More...

Private Types
typedef Common::PtrList< Room >	RoomList

Private Member Functions
void	loadLYT ()

void	loadVIS ()

void	loadART ()

void	loadRooms ()

Room *	currentRoom () const

Private Attributes
RoomList	_rooms
	All rooms in the area. More...

Aurora::LYTFile	_lyt
	The area's layout description. More...

Aurora::VISFile	_vis
	The area's inter-room visibility description. More...

Common::ConfigFile	_art
	The area's environment properties. More...

Detailed Description

A Jade area layout.

Definition at line 46 of file arealayout.h.

Member Typedef Documentation

◆ RoomList

typedef Common::PtrList<Room> Engines::Jade::AreaLayout::RoomList

private

Definition at line 83 of file arealayout.h.

Constructor & Destructor Documentation

◆ AreaLayout() [1/2]

Engines::Jade::AreaLayout::AreaLayout ( const Common::UString & resRef )

Definition at line 49 of file arealayout.cpp.

References clear(), and load().

Here is the call graph for this function:

◆ ~AreaLayout()

Engines::Jade::AreaLayout::~AreaLayout ( )

virtual

Definition at line 58 of file arealayout.cpp.

References clear(), and hide().

Here is the call graph for this function:

◆ AreaLayout() [2/2]

Engines::Jade::AreaLayout::AreaLayout ( )

protected

Definition at line 45 of file arealayout.cpp.

Member Function Documentation

◆ clear()

void Engines::Jade::AreaLayout::clear ( )

protectedvirtual

Reimplemented in Engines::Jade::Area.

Definition at line 159 of file arealayout.cpp.

References _rooms, and Common::PtrList< T, Deallocator >::clear().

Referenced by AreaLayout(), Engines::Jade::Area::clear(), and ~AreaLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ currentRoom()

Room * Engines::Jade::AreaLayout::currentRoom ( ) const

private

Definition at line 218 of file arealayout.cpp.

References _art, _rooms, Common::ConfigFile::getDomain(), and Common::ConfigDomain::getUint().

Referenced by updateCamera().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getResRef()

const Common::UString & Engines::Jade::AreaLayout::getResRef ( )

Return the area's resref (resource ID).

Definition at line 64 of file arealayout.cpp.

References _resRef.

Referenced by Engines::Jade::Functions::jumpTo().

Here is the caller graph for this function:

◆ hide()

void Engines::Jade::AreaLayout::hide ( )

virtual

Reimplemented in Engines::Jade::Area.

Definition at line 85 of file arealayout.cpp.

References _rooms, _visible, and GfxMan.

Referenced by Engines::Jade::MainMenu::hide(), Engines::Jade::Area::hide(), and ~AreaLayout().

Here is the caller graph for this function:

◆ load()

void Engines::Jade::AreaLayout::load ( )

protectedvirtual

Reimplemented in Engines::Jade::Area.

Definition at line 149 of file arealayout.cpp.

References loadART(), loadLYT(), loadResources(), loadRooms(), and loadVIS().

Referenced by AreaLayout(), and Engines::Jade::Area::load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadART()

void Engines::Jade::AreaLayout::loadART ( )

private

Definition at line 198 of file arealayout.cpp.

References _art, _layout, Common::StackException::add(), Common::UString::c_str(), Aurora::kFileTypeART, Common::ConfigFile::load(), and ResMan.

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadLYT()

void Engines::Jade::AreaLayout::loadLYT ( )

private

Definition at line 170 of file arealayout.cpp.

References _layout, _lyt, Common::StackException::add(), Common::UString::c_str(), Aurora::kFileTypeLYT, Aurora::LYTFile::load(), and ResMan.

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadResources()

void Engines::Jade::AreaLayout::loadResources ( )

protectedvirtual

Reimplemented in Engines::Jade::Area.

Definition at line 163 of file arealayout.cpp.

References _resources, _resRef, and Engines::indexMandatoryArchive().

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadRooms()

void Engines::Jade::AreaLayout::loadRooms ( )

private

Definition at line 212 of file arealayout.cpp.

References _lyt, _rooms, and Aurora::LYTFile::getRooms().

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadVIS()

void Engines::Jade::AreaLayout::loadVIS ( )

private

Definition at line 184 of file arealayout.cpp.

References _layout, _vis, Common::StackException::add(), Common::UString::c_str(), Aurora::kFileTypeVIS, Aurora::VISFile::load(), and ResMan.

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ show()

void Engines::Jade::AreaLayout::show ( )

virtual

Reimplemented in Engines::Jade::Area.

Definition at line 68 of file arealayout.cpp.

References _rooms, _visible, GfxMan, and updateCamera().

Referenced by Engines::Jade::MainMenu::show(), and Engines::Jade::Area::show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateCamera()

void Engines::Jade::AreaLayout::updateCamera ( )

Definition at line 100 of file arealayout.cpp.

References _art, CameraMan, currentRoom(), Common::UString::format(), Common::ConfigFile::getDomain(), Common::ConfigDomain::getInt(), Engines::Jade::Room::getResRef(), Common::ConfigDomain::getString(), Common::ConfigDomain::getUint(), Common::parseString(), and Common::UString::split().

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ _art

Common::ConfigFile Engines::Jade::AreaLayout::_art

private

The area's environment properties.

Definition at line 90 of file arealayout.h.

Referenced by currentRoom(), loadART(), and updateCamera().

◆ _layout

Common::UString Engines::Jade::AreaLayout::_layout

protected

The area's layout resref (resource ID).

Definition at line 69 of file arealayout.h.

Referenced by Engines::Jade::Area::loadARE(), loadART(), loadLYT(), Engines::Jade::Area::loadResources(), and loadVIS().

◆ _lyt

Aurora::LYTFile Engines::Jade::AreaLayout::_lyt

private

The area's layout description.

Definition at line 88 of file arealayout.h.

Referenced by loadLYT(), and loadRooms().

◆ _resources

std::list<Common::ChangeID> Engines::Jade::AreaLayout::_resources

protected

The area's resource archives.

Definition at line 71 of file arealayout.h.

Referenced by loadResources(), and Engines::Jade::Area::loadResources().

◆ _resRef

Common::UString Engines::Jade::AreaLayout::_resRef

protected

The area's resref (resource ID).

Definition at line 68 of file arealayout.h.

Referenced by Engines::Jade::Area::Area(), getResRef(), Engines::Jade::Area::load(), loadResources(), and Engines::Jade::Area::loadResources().

◆ _rooms

RoomList Engines::Jade::AreaLayout::_rooms

private

All rooms in the area.

Definition at line 86 of file arealayout.h.

Referenced by clear(), currentRoom(), hide(), loadRooms(), and show().

◆ _vis

Aurora::VISFile Engines::Jade::AreaLayout::_vis

private

The area's inter-room visibility description.

Definition at line 89 of file arealayout.h.

Referenced by loadVIS().

◆ _visible

bool Engines::Jade::AreaLayout::_visible

protected

Is the area currently visible?

Definition at line 73 of file arealayout.h.

Referenced by hide(), Engines::Jade::Area::hide(), show(), and Engines::Jade::Area::show().

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

src/engines/jade/arealayout.h
src/engines/jade/arealayout.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ RoomList

Constructor & Destructor Documentation

◆ AreaLayout() [1/2]

◆ ~AreaLayout()

◆ AreaLayout() [2/2]

Member Function Documentation

◆ clear()

◆ currentRoom()

◆ getResRef()

◆ hide()

◆ load()

◆ loadART()

◆ loadLYT()

◆ loadResources()

◆ loadRooms()

◆ loadVIS()

◆ show()

◆ updateCamera()

Member Data Documentation

◆ _art

◆ _layout

◆ _lyt

◆ _resources

◆ _resRef

◆ _rooms

◆ _vis

◆ _visible