Состояние элемента интерфейса. More...

#include <qd_interface_element_state.h>

Inheritance diagram for QDEngine::qdInterfaceElementState:

Public Types
enum	state_mode_t { DEFAULT_MODE = 0, MOUSE_HOVER_MODE, EVENT_MODE }
	Идентификаторы для режимов работы состояния. More...

enum	{ NUM_MODES = 3 }

typedef Std::vector< qdInterfaceEvent >	events_container_t

Public Member Functions
	qdInterfaceElementState (const qdInterfaceElementState &st)

qdInterfaceElementState &	operator= (const qdInterfaceElementState &st)

void	set_sound_file (const Common::Path str, state_mode_t snd_id=DEFAULT_MODE)
	Устанавливает имя файла звукового эффекта, привязанного к состоянию. More...

const Common::Path	sound_file (state_mode_t snd_id=DEFAULT_MODE) const
	Возвращает имя файла звукового эффекта, привязанного к состоянию.

const qdSound *	sound (state_mode_t snd_id=DEFAULT_MODE) const
	Возвращает указатель на звуковой эффект, привязанный к состоянию.

bool	has_sound (state_mode_t snd_id=DEFAULT_MODE) const
	Возвращает true, если к состоянию привязан звук.

void	set_animation_file (const Common::Path name, state_mode_t anm_id=DEFAULT_MODE)
	Устанавливает имя файла для анимации. More...

const Common::Path	animation_file (state_mode_t anm_id=DEFAULT_MODE) const
	Возвращает имя файла для анимации.

int	animation_flags (state_mode_t anm_id=DEFAULT_MODE) const
	Возвращает флаги анимации.

void	set_animation_flag (int fl, state_mode_t anm_id=DEFAULT_MODE)
	Устанавливает флаг анимации.

void	drop_animation_flag (int fl, state_mode_t anm_id=DEFAULT_MODE)
	Скидывает флаг анимации.

bool	check_animation_flag (int fl, state_mode_t anm_id=DEFAULT_MODE) const
	Возвращает true, если для анимации установлен флаг fl.

const qdAnimation *	animation (state_mode_t anm_id=DEFAULT_MODE) const
	Возвращает указатель на анимацию, привязанную к состоянию.

bool	has_animation (state_mode_t anm_id=DEFAULT_MODE) const
	Возвращает true, если к состоянию привязана анимация.

bool	register_resources ()
	Регистрирует ресурсы, связанные с состоянием (анимацию и звук).

bool	unregister_resources ()
	Высвобождает ресурсы, связанные с состоянием (анимацию и звук).

bool	save_script (Common::WriteStream &fh, int indent=0) const
	Запись данных в скрипт.

bool	load_script (const xml::tag *p)
	Загрузка данных из скрипта.

bool	quant (float dt)
	Обсчет логики, параметр - время в секундах. More...

void	set_state_mode (state_mode_t mode)
	Устанавливает режим работы состояния.

state_mode_t	state_mode () const
	Возвращает режим работы состояния.

bool	has_state_mode (state_mode_t mode) const
	Возвращает true, если у состояния может быть включен режим работы mode.

bool	has_contour (state_mode_t mode) const
	Возвращает true, если у состояния задан контур для режима mode.

bool	get_contour (state_mode_t mode, qdContour &cnt) const
	Записывает контур режима mode в cnt.

bool	set_contour (state_mode_t mode, const qdContour &cnt)
	Устанавливает контур для режима mode.

bool	hit_test (int x, int y, state_mode_t mode) const
	Возвращает true, если точка с экранными координатами (x,у) попадает внутрь контура режима mode.

bool	mouse_handler (int x, int y, mouseDispatcher::mouseEvent ev)
	Обработчик событий мыши.

bool	keyboard_handler (Common::KeyCode vkey)
	Обработчик ввода с клавиатуры.

const events_container_t &	events () const
	Список событий.

void	add_event (const qdInterfaceEvent &ev)
	Добавление события.

void	erase_event (int iNum)
	Уделение события

void	erase_all_events ()
	Удаление всех событий

bool	need_active_game () const

const qdInterfaceEvent *	find_event (qdInterfaceEvent::event_t type) const

bool	has_event (qdInterfaceEvent::event_t type, const char *ev_data=NULL) const

Public Member Functions inherited from QDEngine::qdInterfaceObjectBase
	qdInterfaceObjectBase (const qdInterfaceObjectBase &obj)

void	set_owner (qdInterfaceObjectBase *p)
	Устанавливает владельца объекта.

qdInterfaceObjectBase *	owner () const
	Возвращает указатель на владельца объекта.

Public Member Functions inherited from QDEngine::qdNamedObjectBase
	qdNamedObjectBase (const qdNamedObjectBase &obj)

qdNamedObjectBase &	operator= (const qdNamedObjectBase &obj)

const char *	name () const
	Возвращает имя объекта.

void	set_name (const char *p)
	Устанавливает имя объекта.

Additional Inherited Members
Protected Member Functions inherited from QDEngine::qdInterfaceObjectBase
qdInterfaceObjectBase &	operator= (const qdInterfaceObjectBase &obj)

Detailed Description

Состояние элемента интерфейса.

Member Enumeration Documentation

◆ state_mode_t

enum QDEngine::qdInterfaceElementState::state_mode_t

Идентификаторы для режимов работы состояния.

Enumerator
DEFAULT_MODE	режим по умолчанию
MOUSE_HOVER_MODE	режим, который включается когда мышиный курсор находится над элементом-владельцем
EVENT_MODE	режим, который включается при клике по элементу-владельцу

◆ anonymous enum

anonymous enum

Enumerator
NUM_MODES	количество режимов работы состояния

Member Function Documentation

◆ set_sound_file()

void QDEngine::qdInterfaceElementState::set_sound_file	(	const Common::Path	str,
		state_mode_t	snd_id = `DEFAULT_MODE`
	)

Устанавливает имя файла звукового эффекта, привязанного к состоянию.

Если надо убрать звук - передать NULL в качестве имени файла.

◆ set_animation_file()

void QDEngine::qdInterfaceElementState::set_animation_file	(	const Common::Path	name,
		state_mode_t	anm_id = `DEFAULT_MODE`
	)

Устанавливает имя файла для анимации.

Если надо убрать анимацию - передать NULL в качестве имени файла.

◆ quant()

bool QDEngine::qdInterfaceElementState::quant ( float dt )

Обсчет логики, параметр - время в секундах.

Вызывается владельцем для активного состояния.

◆ need_active_game()

bool QDEngine::qdInterfaceElementState::need_active_game ( ) const

Возвращает true, если хотя бы для одного из событий состояния необходимо наличие загруженной сцены (т.е. оно происходит только во время игры).

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

engines/qdengine/qdcore/qd_interface_element_state.h

Public Types

Public Member Functions

Additional Inherited Members