File: layer.h

package info (click to toggle)
residualvm 0.3.1%2Bdfsg-2
  • links: PTS, VCS
  • area: contrib
  • in suites: bullseye
  • size: 31,292 kB
  • sloc: cpp: 227,029; sh: 7,256; xml: 1,731; perl: 1,067; java: 861; asm: 738; python: 691; ansic: 272; makefile: 139; objc: 81; sed: 22; php: 1
file content (158 lines) | stat: -rw-r--r-- 4,160 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/* ResidualVM - A 3D game interpreter
 *
 * ResidualVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the AUTHORS
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#ifndef STARK_RESOURCES_LAYER_H
#define STARK_RESOURCES_LAYER_H

#include "common/array.h"
#include "common/str.h"

#include "engines/stark/gfx/renderentry.h"
#include "engines/stark/resources/object.h"

namespace Stark {

namespace Formats {
class XRCReadStream;
}

namespace Resources {

class Item;

/**
 * A location layer
 *
 * Layers own the scene items
 */
class Layer : public Object {
public:
	static const Type::ResourceType TYPE = Type::kLayer;

	enum SubType {
		kLayer2D = 1,
		kLayer3D = 2
	};

	/** Layer factory */
	static Object *construct(Object *parent, byte subType, uint16 index, const Common::String &name);

	Layer(Object *parent, byte subType, uint16 index, const Common::String &name);
	virtual ~Layer();

	// Resource API
	virtual void readData(Formats::XRCReadStream *stream) override;
	virtual void saveLoad(ResourceSerializer *serializer) override;
	virtual void saveLoadCurrent(ResourceSerializer *serializer) override;

	/** Obtain the render entry for the background item */
	virtual Gfx::RenderEntry *getBackgroundRenderEntry() = 0;

	/** Obtain the render entries for all items, including the background */
	virtual Gfx::RenderEntryArray listRenderEntries() = 0;

	/** Obtain a list of render entries for all the lights in the layer */
	Gfx::LightEntryArray listLightEntries();

	/** Scroll the layer to the specified position */
	void setScrollPosition(const Common::Point &position);

	/** Get the current scroll for this layer */
	Common::Point getScroll() const;

	/** Set the current scroll for this layer */
	void setScroll(const Common::Point &scroll);

	/** Enable the layer */
	void enable(bool enabled);

	/** Is the layer enabled? Disabled layers are not drawn. */
	bool isEnabled() const;

protected:
	void printData() override;

	Common::Point _scroll;
	float _scrollScale; // Used for the parallax effect
	bool _enabled;
};

/**
 * A 2D layer
 *
 * 2D layers contain 2D positioned items
 */
class Layer2D : public Layer {
public:
	Layer2D(Object *parent, byte subType, uint16 index, const Common::String &name);
	virtual ~Layer2D();

	// Resource API
	void readData(Formats::XRCReadStream *stream) override;
	void onEnterLocation() override;
	void onExitLocation() override;

	// Layer API
	Gfx::RenderEntry *getBackgroundRenderEntry() override;
	Gfx::RenderEntryArray listRenderEntries() override;

protected:
	void printData() override;

	Common::Array<uint32> _itemIndices;
	Common::Array<Item *> _items;
};

/**
 * A 3D layer
 *
 * 3D layers contain 3D positioned items, a camera and a floorfield
 */
class Layer3D : public Layer {
public:
	Layer3D(Object *parent, byte subType, uint16 index, const Common::String &name);
	virtual ~Layer3D();

	// Resource API
	void readData(Formats::XRCReadStream *stream) override;
	void onAllLoaded() override;

	// Layer API
	Gfx::RenderEntry *getBackgroundRenderEntry() override;
	Gfx::RenderEntryArray listRenderEntries() override;

protected:
	void printData() override;

	uint32 _field_54;
	uint32 _maxShadowLength;
	float _nearClipPlane;
	float _farClipPlane;

	Item *_backgroundItem;
	Common::Array<Item *> _items;
};

} // End of namespace Resources
} // End of namespace Stark

#endif // STARK_RESOURCES_LAYER_H