minetest
/
irrlicht
mirror of https://github.com/minetest/irrlicht.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Reformat the code, using: 

find -type f |  # list all regular files
  grep -E '\.(h|cpp|mm)$' |  # filter for source files
  grep -v '/mt_' |  # filter out generated files
  grep -v '/vendor/' | # and vendored GL
  grep -v '/test/image_loader_test.cpp' |  # and this file (has giant literals arrays)
  xargs -n 1 -P $(nproc) clang-format -i  # reformat everything

Co-authored-by: numzero <numzer0@yandex.ru>
This commit is contained in:
Desour 2024-03-20 19:35:52 +01:00
parent eb4dec46c2
commit 2bf1d12353
292 changed files with 37376 additions and 42421 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
examples/AutomatedTest/main.cpp
View File

@ -28,14 +28,14 @@ static video::E_DRIVER_TYPE chooseDriver(core::stringc arg_)
static inline void check(bool ok, const char *msg)
{
if (!ok)
{
if (!ok) {
test_fail++;
device->getLogger()->log((core::stringc("FAILED TEST: ") + msg).c_str(), ELL_ERROR);
}
}
void run_unit_tests() {
void run_unit_tests()
{
std::cout << "Running unit tests:" << std::endl;
try {
test_irr_array();
@ -72,35 +72,33 @@ int main(int argc, char *argv[])
device->setWindowCaption(L"Hello World!");
device->setResizable(true);
video::IVideoDriver* driver = device->getVideoDriver();
scene::ISceneManager* smgr = device->getSceneManager();
gui::IGUIEnvironment* guienv = device->getGUIEnvironment();
video::IVideoDriver *driver = device->getVideoDriver();
scene::ISceneManager *smgr = device->getSceneManager();
gui::IGUIEnvironment *guienv = device->getGUIEnvironment();
guienv->addStaticText(L"sample text", core::rect<s32>(10,10,110,22), false);
guienv->addStaticText(L"sample text", core::rect<s32>(10, 10, 110, 22), false);
gui::IGUIButton* button = guienv->addButton(
core::rect<s32>(10,30,110,30 + 32), 0, -1, L"sample button",
gui::IGUIButton *button = guienv->addButton(
core::rect<s32>(10, 30, 110, 30 + 32), 0, -1, L"sample button",
L"sample tooltip");
gui::IGUIEditBox* editbox = guienv->addEditBox(L"",
core::rect<s32>(10,70,60,70 + 16));
gui::IGUIEditBox *editbox = guienv->addEditBox(L"",
core::rect<s32>(10, 70, 60, 70 + 16));
const io::path mediaPath = getExampleMediaPath();
auto mesh_file = device->getFileSystem()->createAndOpenFile(mediaPath + "coolguy_opt.x");
check(mesh_file, "mesh file loading");
scene::IAnimatedMesh* mesh = smgr->getMesh(mesh_file);
scene::IAnimatedMesh *mesh = smgr->getMesh(mesh_file);
check(mesh, "mesh loading");
if (mesh_file)
mesh_file->drop();
if (mesh)
{
video::ITexture* tex = driver->getTexture(mediaPath + "cooltexture.png");
if (mesh) {
video::ITexture *tex = driver->getTexture(mediaPath + "cooltexture.png");
check(tex, "texture loading");
scene::IAnimatedMeshSceneNode* node = smgr->addAnimatedMeshSceneNode(mesh);
if (node)
{
node->forEachMaterial([tex] (video::SMaterial &mat) {
scene::IAnimatedMeshSceneNode *node = smgr->addAnimatedMeshSceneNode(mesh);
if (node) {
node->forEachMaterial([tex](video::SMaterial &mat) {
mat.Lighting = false;
mat.setTexture(0, tex);
});
@ -109,16 +107,14 @@ int main(int argc, char *argv[])
}
}
smgr->addCameraSceneNode(0, core::vector3df(0,4,5), core::vector3df(0,2,0));
smgr->addCameraSceneNode(0, core::vector3df(0, 4, 5), core::vector3df(0, 2, 0));
s32 n = 0;
SEvent event;
device->getTimer()->start();
while (device->run())
{
if (device->getTimer()->getTime() >= 1000)
{
while (device->run()) {
if (device->getTimer()->getTime() >= 1000) {
device->getTimer()->setTime(0);
++n;
if (n == 1) // Tooltip display
@ -129,8 +125,7 @@ int main(int argc, char *argv[])
event.MouseInput.X = button->getAbsolutePosition().getCenter().X;
event.MouseInput.Y = button->getAbsolutePosition().getCenter().Y;
device->postEventFromUser(event);
}
else if (n == 2) // Text input focus
} else if (n == 2) // Text input focus
guienv->setFocus(editbox);
else if (n == 3) // Keypress for Text input
{
@ -142,13 +137,12 @@ int main(int argc, char *argv[])
device->postEventFromUser(event);
event.KeyInput.PressedDown = false;
device->postEventFromUser(event);
}
else
} else
device->closeDevice();
}
driver->beginScene(video::ECBF_COLOR | video::ECBF_DEPTH,
video::SColor(255,100,100,150));
video::SColor(255, 100, 100, 150));
smgr->drawAll();
guienv->drawAll();
driver->endScene();

13
examples/AutomatedTest/test_array.cpp
View File

@ -4,7 +4,8 @@
using namespace irr;
using core::array;
static void test_basics() {
static void test_basics()
{
array<int> v;
v.push_back(1); // 1
v.push_front(2); // 2, 1
@ -57,7 +58,8 @@ static void test_basics() {
UASSERTEQ(v.size(), 2);
}
static void test_linear_searches() {
static void test_linear_searches()
{
// Populate the array with 0, 1, 2, ..., 100, 100, 99, 98, 97, ..., 0
array<int> arr;
for (int i = 0; i <= 100; i++)
@ -75,14 +77,15 @@ static void test_linear_searches() {
}
}
static void test_binary_searches() {
const auto& values = { 3, 5, 1, 2, 5, 10, 19, 9, 7, 1, 2, 5, 8, 15 };
static void test_binary_searches()
{
const auto &values = {3, 5, 1, 2, 5, 10, 19, 9, 7, 1, 2, 5, 8, 15};
array<int> arr;
for (int value : values) {
arr.push_back(value);
}
// Test the const form first, it uses a linear search without sorting
const array<int> & carr = arr;
const array<int> &carr = arr;
UASSERTEQ(carr.binary_search(20), -1);
UASSERTEQ(carr.binary_search(0), -1);
UASSERTEQ(carr.binary_search(1), 2);

11
examples/AutomatedTest/test_helper.h
View File

@ -3,11 +3,13 @@
#include <exception>
#include <iostream>
class TestFailedException : public std::exception {
class TestFailedException : public std::exception
{
};
// Asserts the comparison specified by CMP is true, or fails the current unit test
#define UASSERTCMP(CMP, actual, expected) do { \
#define UASSERTCMP(CMP, actual, expected) \
do { \
const auto &a = (actual); \
const auto &e = (expected); \
if (!CMP(a, e)) { \
@ -15,11 +17,12 @@ class TestFailedException : public std::exception {
<< "Test assertion failed: " << #actual << " " << #CMP << " " \
<< #expected << std::endl \
<< " at " << __FILE__ << ":" << __LINE__ << std::endl \
<< " actual: " << a << std::endl << " expected: " \
<< " actual: " << a << std::endl \
<< " expected: " \
<< e << std::endl; \
throw TestFailedException(); \
} \
} while (0)
} while (0)
#define CMPEQ(a, e) (a == e)
#define CMPTRUE(a, e) (a)

10
examples/AutomatedTest/test_string.cpp
View File

@ -38,7 +38,7 @@ static void test_basics()
UASSERTSTR(s, "abcdef");
s = L"abcdef";
UASSERTSTR(s, "abcdef");
s = static_cast<const char*>(nullptr);
s = static_cast<const char *>(nullptr);
UASSERTSTR(s, "");
// operator+
s = s + stringc("foo");
@ -163,7 +163,7 @@ static void test_methods()
UASSERTSTR(res[0], "a");
UASSERTSTR(res[2], "");
for (int i = 0; i < 3; i++)
UASSERTSTR(res[2*i+1], ",");
UASSERTSTR(res[2 * i + 1], ",");
}
static void test_conv()
@ -180,9 +180,9 @@ static void test_conv()
wStringToUTF8(out2, L"†††");
UASSERTEQ(out2.size(), 9);
for (int i = 0; i < 3; i++) {
UASSERTEQ(static_cast<u8>(out2[3*i]), 0xe2);
UASSERTEQ(static_cast<u8>(out2[3*i+1]), 0x80);
UASSERTEQ(static_cast<u8>(out2[3*i+2]), 0xa0);
UASSERTEQ(static_cast<u8>(out2[3 * i]), 0xe2);
UASSERTEQ(static_cast<u8>(out2[3 * i + 1]), 0x80);
UASSERTEQ(static_cast<u8>(out2[3 * i + 2]), 0xa0);
}
// locale-dependent

132
include/CMeshBuffer.h
View File

@ -11,56 +11,48 @@ namespace irr
{
namespace scene
{
//! Template implementation of the IMeshBuffer interface
template <class T>
class CMeshBuffer : public IMeshBuffer
{
public:
//! Template implementation of the IMeshBuffer interface
template <class T>
class CMeshBuffer : public IMeshBuffer
{
public:
//! Default constructor for empty meshbuffer
CMeshBuffer()
: ChangedID_Vertex(1), ChangedID_Index(1)
, MappingHint_Vertex(EHM_NEVER), MappingHint_Index(EHM_NEVER)
, HWBuffer(NULL)
, PrimitiveType(EPT_TRIANGLES)
CMeshBuffer() :
ChangedID_Vertex(1), ChangedID_Index(1), MappingHint_Vertex(EHM_NEVER), MappingHint_Index(EHM_NEVER), HWBuffer(NULL), PrimitiveType(EPT_TRIANGLES)
{
#ifdef _DEBUG
#ifdef _DEBUG
setDebugName("CMeshBuffer");
#endif
#endif
}
//! Get material of this meshbuffer
/** \return Material of this buffer */
const video::SMaterial& getMaterial() const override
const video::SMaterial &getMaterial() const override
{
return Material;
}
//! Get material of this meshbuffer
/** \return Material of this buffer */
video::SMaterial& getMaterial() override
video::SMaterial &getMaterial() override
{
return Material;
}
//! Get pointer to vertices
/** \return Pointer to vertices. */
const void* getVertices() const override
const void *getVertices() const override
{
return Vertices.const_pointer();
}
//! Get pointer to vertices
/** \return Pointer to vertices. */
void* getVertices() override
void *getVertices() override
{
return Vertices.pointer();
}
//! Get number of vertices
/** \return Number of vertices. */
u32 getVertexCount() const override
@ -77,20 +69,18 @@ namespace scene
//! Get pointer to indices
/** \return Pointer to indices. */
const u16* getIndices() const override
const u16 *getIndices() const override
{
return Indices.const_pointer();
}
//! Get pointer to indices
/** \return Pointer to indices. */
u16* getIndices() override
u16 *getIndices() override
{
return Indices.pointer();
}
//! Get number of indices
/** \return Number of indices. */
u32 getIndexCount() const override
@ -98,40 +88,33 @@ namespace scene
return Indices.size();
}
//! Get the axis aligned bounding box
/** \return Axis aligned bounding box of this buffer. */
const core::aabbox3d<f32>& getBoundingBox() const override
const core::aabbox3d<f32> &getBoundingBox() const override
{
return BoundingBox;
}
//! Set the axis aligned bounding box
/** \param box New axis aligned bounding box for this buffer. */
//! set user axis aligned bounding box
void setBoundingBox(const core::aabbox3df& box) override
void setBoundingBox(const core::aabbox3df &box) override
{
BoundingBox = box;
}
//! Recalculate the bounding box.
/** should be called if the mesh changed. */
void recalculateBoundingBox() override
{
if (!Vertices.empty())
{
if (!Vertices.empty()) {
BoundingBox.reset(Vertices[0].Pos);
const irr::u32 vsize = Vertices.size();
for (u32 i=1; i<vsize; ++i)
for (u32 i = 1; i < vsize; ++i)
BoundingBox.addInternalPoint(Vertices[i].Pos);
} else
BoundingBox.reset(0, 0, 0);
}
else
BoundingBox.reset(0,0,0);
}
//! Get type of vertex data stored in this buffer.
/** \return Type of vertex data. */
@ -141,48 +124,47 @@ namespace scene
}
//! returns position of vertex i
const core::vector3df& getPosition(u32 i) const override
const core::vector3df &getPosition(u32 i) const override
{
return Vertices[i].Pos;
}
//! returns position of vertex i
core::vector3df& getPosition(u32 i) override
core::vector3df &getPosition(u32 i) override
{
return Vertices[i].Pos;
}
//! returns normal of vertex i
const core::vector3df& getNormal(u32 i) const override
const core::vector3df &getNormal(u32 i) const override
{
return Vertices[i].Normal;
}
//! returns normal of vertex i
core::vector3df& getNormal(u32 i) override
core::vector3df &getNormal(u32 i) override
{
return Vertices[i].Normal;
}
//! returns texture coord of vertex i
const core::vector2df& getTCoords(u32 i) const override
const core::vector2df &getTCoords(u32 i) const override
{
return Vertices[i].TCoords;
}
//! returns texture coord of vertex i
core::vector2df& getTCoords(u32 i) override
core::vector2df &getTCoords(u32 i) override
{
return Vertices[i].TCoords;
}
//! Append the vertices and indices to the current buffer
/** Only works for compatible types, i.e. either the same type
or the main buffer is of standard type. Otherwise, behavior is
undefined.
*/
void append(const void* const vertices, u32 numVertices, const u16* const indices, u32 numIndices) override
void append(const void *const vertices, u32 numVertices, const u16 *const indices, u32 numIndices) override
{
if (vertices == getVertices())
return;
@ -190,21 +172,18 @@ namespace scene
const u32 vertexCount = getVertexCount();
u32 i;
Vertices.reallocate(vertexCount+numVertices);
for (i=0; i<numVertices; ++i)
{
Vertices.push_back(static_cast<const T*>(vertices)[i]);
BoundingBox.addInternalPoint(static_cast<const T*>(vertices)[i].Pos);
Vertices.reallocate(vertexCount + numVertices);
for (i = 0; i < numVertices; ++i) {
Vertices.push_back(static_cast<const T *>(vertices)[i]);
BoundingBox.addInternalPoint(static_cast<const T *>(vertices)[i].Pos);
}
Indices.reallocate(getIndexCount()+numIndices);
for (i=0; i<numIndices; ++i)
{
Indices.push_back(indices[i]+vertexCount);
Indices.reallocate(getIndexCount() + numIndices);
for (i = 0; i < numIndices; ++i) {
Indices.push_back(indices[i] + vertexCount);
}
}
//! get the current hardware mapping hint
E_HARDWARE_MAPPING getHardwareMappingHint_Vertex() const override
{
@ -218,12 +197,12 @@ namespace scene
}
//! set the hardware mapping hint, for driver
void setHardwareMappingHint( E_HARDWARE_MAPPING NewMappingHint, E_BUFFER_TYPE Buffer=EBT_VERTEX_AND_INDEX ) override
void setHardwareMappingHint(E_HARDWARE_MAPPING NewMappingHint, E_BUFFER_TYPE Buffer = EBT_VERTEX_AND_INDEX) override
{
if (Buffer==EBT_VERTEX_AND_INDEX || Buffer==EBT_VERTEX)
MappingHint_Vertex=NewMappingHint;
if (Buffer==EBT_VERTEX_AND_INDEX || Buffer==EBT_INDEX)
MappingHint_Index=NewMappingHint;
if (Buffer == EBT_VERTEX_AND_INDEX || Buffer == EBT_VERTEX)
MappingHint_Vertex = NewMappingHint;
if (Buffer == EBT_VERTEX_AND_INDEX || Buffer == EBT_INDEX)
MappingHint_Index = NewMappingHint;
}
//! Describe what kind of primitive geometry is used by the meshbuffer
@ -239,31 +218,32 @@ namespace scene
}
//! flags the mesh as changed, reloads hardware buffers
void setDirty(E_BUFFER_TYPE Buffer=EBT_VERTEX_AND_INDEX) override
void setDirty(E_BUFFER_TYPE Buffer = EBT_VERTEX_AND_INDEX) override
{
if (Buffer==EBT_VERTEX_AND_INDEX ||Buffer==EBT_VERTEX)
if (Buffer == EBT_VERTEX_AND_INDEX || Buffer == EBT_VERTEX)
++ChangedID_Vertex;
if (Buffer==EBT_VERTEX_AND_INDEX || Buffer==EBT_INDEX)
if (Buffer == EBT_VERTEX_AND_INDEX || Buffer == EBT_INDEX)
++ChangedID_Index;
}
//! Get the currently used ID for identification of changes.
/** This shouldn't be used for anything outside the VideoDriver. */
u32 getChangedID_Vertex() const override {return ChangedID_Vertex;}
u32 getChangedID_Vertex() const override { return ChangedID_Vertex; }
//! Get the currently used ID for identification of changes.
/** This shouldn't be used for anything outside the VideoDriver. */
u32 getChangedID_Index() const override {return ChangedID_Index;}
u32 getChangedID_Index() const override { return ChangedID_Index; }
void setHWBuffer(void *ptr) const override {
void setHWBuffer(void *ptr) const override
{
HWBuffer = ptr;
}
void *getHWBuffer() const override {
void *getHWBuffer() const override
{
return HWBuffer;
}
u32 ChangedID_Vertex;
u32 ChangedID_Index;
@ -282,13 +262,13 @@ namespace scene
core::aabbox3d<f32> BoundingBox;
//! Primitive type used for rendering (triangles, lines, ...)
E_PRIMITIVE_TYPE PrimitiveType;
};
};
//! Standard meshbuffer
typedef CMeshBuffer<video::S3DVertex> SMeshBuffer;
//! Meshbuffer with two texture coords per vertex, e.g. for lightmaps
typedef CMeshBuffer<video::S3DVertex2TCoords> SMeshBufferLightMap;
//! Meshbuffer with vertices having tangents stored, e.g. for normal mapping
typedef CMeshBuffer<video::S3DVertexTangents> SMeshBufferTangents;
//! Standard meshbuffer
typedef CMeshBuffer<video::S3DVertex> SMeshBuffer;
//! Meshbuffer with two texture coords per vertex, e.g. for lightmaps
typedef CMeshBuffer<video::S3DVertex2TCoords> SMeshBufferLightMap;
//! Meshbuffer with vertices having tangents stored, e.g. for normal mapping
typedef CMeshBuffer<video::S3DVertexTangents> SMeshBufferTangents;
} // end namespace scene
} // end namespace irr

15
include/ECullingTypes.h
View File

@ -11,26 +11,25 @@ namespace irr
namespace scene
{
//! An enumeration for all types of automatic culling for built-in scene nodes
enum E_CULLING_TYPE
{
//! An enumeration for all types of automatic culling for built-in scene nodes
enum E_CULLING_TYPE
{
EAC_OFF = 0,
EAC_BOX = 1,
EAC_FRUSTUM_BOX = 2,
EAC_FRUSTUM_SPHERE = 4,
EAC_OCC_QUERY = 8
};
};
//! Names for culling type
const c8* const AutomaticCullingNames[] =
//! Names for culling type
const c8 *const AutomaticCullingNames[] =
{
"false",
"box", // camera box against node box
"frustum_box", // camera frustum against node box
"frustum_sphere", // camera frustum against node sphere
"occ_query", // occlusion query
0
};
0};
} // end namespace scene
} // end namespace irr

9
include/EDebugSceneTypes.h
View File

@ -9,9 +9,9 @@ namespace irr
namespace scene
{
//! An enumeration for all types of debug data for built-in scene nodes (flags)
enum E_DEBUG_SCENE_TYPE
{
//! An enumeration for all types of debug data for built-in scene nodes (flags)
enum E_DEBUG_SCENE_TYPE
{
//! No Debug Data ( Default )
EDS_OFF = 0,
@ -35,8 +35,7 @@ namespace scene
//! Show all debug infos
EDS_FULL = 0xffffffff
};
};
} // end namespace scene
} // end namespace irr

8
include/EDeviceTypes.h
View File

@ -7,9 +7,9 @@
namespace irr
{
//! An enum for the different device types supported by the Irrlicht Engine.
enum E_DEVICE_TYPE
{
//! An enum for the different device types supported by the Irrlicht Engine.
enum E_DEVICE_TYPE
{
//! A device native to Microsoft Windows
/** This device uses the Win32 API and works in all versions of Windows. */
@ -41,6 +41,6 @@ namespace irr
Does not need X11 or other graphical subsystems.
May support hw-acceleration via OpenGL-ES */
EIDT_ANDROID,
};
};
} // end namespace irr

8
include/EDriverFeatures.h
View File

@ -9,9 +9,9 @@ namespace irr
namespace video
{
//! enumeration for querying features of the video driver.
enum E_VIDEO_DRIVER_FEATURE
{
//! enumeration for querying features of the video driver.
enum E_VIDEO_DRIVER_FEATURE
{
//! Is driver able to render to a surface?
EVDF_RENDER_TO_TARGET = 0,
@ -131,7 +131,7 @@ namespace video
//! Only used for counting the elements of this enum
EVDF_COUNT
};
};
} // end namespace video
} // end namespace irr

8
include/EDriverTypes.h
View File

@ -11,9 +11,9 @@ namespace irr
namespace video
{
//! An enum for all types of drivers the Irrlicht Engine supports.
enum E_DRIVER_TYPE
{
//! An enum for all types of drivers the Irrlicht Engine supports.
enum E_DRIVER_TYPE
{
//! Null driver, useful for applications to run the engine without visualization.
/** The null device is able to load textures, but does not
render and display any graphics. */
@ -38,7 +38,7 @@ namespace video
//! No driver, just for counting the elements
EDT_COUNT
};
};
} // end namespace video
} // end namespace irr

9
include/EGUIAlignment.h
View File

@ -13,7 +13,7 @@ namespace gui
enum EGUI_ALIGNMENT
{
//! Aligned to parent's top or left side (default)
EGUIA_UPPERLEFT=0,
EGUIA_UPPERLEFT = 0,
//! Aligned to parent's bottom or right side
EGUIA_LOWERRIGHT,
//! Aligned to the center of parent
@ -23,14 +23,13 @@ enum EGUI_ALIGNMENT
};
//! Names for alignments
const c8* const GUIAlignmentNames[] =
{
const c8 *const GUIAlignmentNames[] =
{
"upperLeft",
"lowerRight",
"center",
"scale",
0
};
0};
} // namespace gui
} // namespace irr

7
include/EGUIElementTypes.h
View File

@ -99,8 +99,8 @@ enum EGUI_ELEMENT_TYPE
};
//! Names for built-in element types
const c8* const GUIElementTypeNames[] =
{
const c8 *const GUIElementTypeNames[] =
{
"button",
"checkBox",
"comboBox",
@ -127,8 +127,7 @@ const c8* const GUIElementTypeNames[] =
"element",
"root",
"profiler",
0
};
0};
} // end namespace gui
} // end namespace irr

16
include/EHardwareBufferFlags.h
View File

@ -9,10 +9,10 @@ namespace irr
namespace scene
{
enum E_HARDWARE_MAPPING
{
enum E_HARDWARE_MAPPING
{
//! Don't store on the hardware
EHM_NEVER=0,
EHM_NEVER = 0,
//! Rarely changed, usually stored completely on the hardware
EHM_STATIC,
@ -22,19 +22,19 @@ namespace scene
//! Always changed, cache optimizing on the GPU
EHM_STREAM
};
};
enum E_BUFFER_TYPE
{
enum E_BUFFER_TYPE
{
//! Does not change anything
EBT_NONE=0,
EBT_NONE = 0,
//! Change the vertex mapping
EBT_VERTEX,
//! Change the index mapping
EBT_INDEX,
//! Change both vertex and index mapping to the same value
EBT_VERTEX_AND_INDEX
};
};
} // end namespace scene
} // end namespace irr

8
include/EMaterialProps.h
View File

@ -9,9 +9,9 @@ namespace irr
namespace video
{
//! Material properties
enum E_MATERIAL_PROP
{
//! Material properties
enum E_MATERIAL_PROP
{
//! Corresponds to SMaterial::Wireframe.
EMP_WIREFRAME = 0x1,
@ -76,7 +76,7 @@ namespace video
//! Corresponds to SMaterial::BlendFactor.
EMP_BLEND_FACTOR = 0x100000,
};
};
} // end namespace video
} // end namespace irr

19
include/EMaterialTypes.h
View File

@ -11,9 +11,9 @@ namespace irr
namespace video
{
//! Abstracted and easy to use fixed function/programmable pipeline material modes.
enum E_MATERIAL_TYPE
{
//! Abstracted and easy to use fixed function/programmable pipeline material modes.
enum E_MATERIAL_TYPE
{
//! Standard solid material.
/** Only first texture is used, which is supposed to be the
diffuse material. */
@ -55,21 +55,20 @@ namespace video
//! This value is not used. It only forces this enumeration to compile to 32 bit.
EMT_FORCE_32BIT = 0x7fffffff
};
};
//! Array holding the built in material type names
const char* const sBuiltInMaterialTypeNames[] =
//! Array holding the built in material type names
const char *const sBuiltInMaterialTypeNames[] =
{
"solid",
"trans_alphach",
"trans_alphach_ref",
"trans_vertex_alpha",
"onetexture_blend",
0
};
0};
constexpr u32 numBuiltInMaterials =
sizeof(sBuiltInMaterialTypeNames) / sizeof(char*) - 1;
constexpr u32 numBuiltInMaterials =
sizeof(sBuiltInMaterialTypeNames) / sizeof(char *) - 1;
} // end namespace video
} // end namespace irr

10
include/EPrimitiveTypes.h
View File

@ -9,11 +9,11 @@ namespace irr
namespace scene
{
//! Enumeration for all primitive types there are.
enum E_PRIMITIVE_TYPE
{
//! Enumeration for all primitive types there are.
enum E_PRIMITIVE_TYPE
{
//! All vertices are non-connected points.
EPT_POINTS=0,
EPT_POINTS = 0,
//! All vertices form a single connected line.
EPT_LINE_STRIP,
@ -37,7 +37,7 @@ namespace scene
//! The single vertices are expanded to quad billboards on the GPU.
EPT_POINT_SPRITES
};
};
} // end namespace scene
} // end namespace irr

16
include/EReadFileType.h
View File

@ -11,20 +11,20 @@ namespace irr
namespace io
{
//! An enumeration for different class types implementing IReadFile
enum EREAD_FILE_TYPE
{
//! An enumeration for different class types implementing IReadFile
enum EREAD_FILE_TYPE
{
//! CReadFile
ERFT_READ_FILE = MAKE_IRR_ID('r','e','a','d'),
ERFT_READ_FILE = MAKE_IRR_ID('r', 'e', 'a', 'd'),
//! CMemoryReadFile
ERFT_MEMORY_READ_FILE = MAKE_IRR_ID('r','m','e','m'),
ERFT_MEMORY_READ_FILE = MAKE_IRR_ID('r', 'm', 'e', 'm'),
//! CLimitReadFile
ERFT_LIMIT_READ_FILE = MAKE_IRR_ID('r','l','i','m'),
ERFT_LIMIT_READ_FILE = MAKE_IRR_ID('r', 'l', 'i', 'm'),
//! Unknown type
EFIT_UNKNOWN = MAKE_IRR_ID('u','n','k','n')
};
EFIT_UNKNOWN = MAKE_IRR_ID('u', 'n', 'k', 'n')
};
} // end namespace io
} // end namespace irr

34
include/ESceneNodeTypes.h
View File

@ -11,41 +11,39 @@ namespace irr
namespace scene
{
//! An enumeration for all types of built-in scene nodes
/** A scene node type is represented by a four character code
such as 'cube' or 'mesh' instead of simple numbers, to avoid
name clashes with external scene nodes.*/
enum ESCENE_NODE_TYPE
{
//! An enumeration for all types of built-in scene nodes
/** A scene node type is represented by a four character code
such as 'cube' or 'mesh' instead of simple numbers, to avoid
name clashes with external scene nodes.*/
enum ESCENE_NODE_TYPE
{
//! of type CSceneManager (note that ISceneManager is not(!) an ISceneNode)
ESNT_SCENE_MANAGER = MAKE_IRR_ID('s','m','n','g'),
ESNT_SCENE_MANAGER = MAKE_IRR_ID('s', 'm', 'n', 'g'),
//! Mesh Scene Node
ESNT_MESH = MAKE_IRR_ID('m','e','s','h'),
ESNT_MESH = MAKE_IRR_ID('m', 'e', 's', 'h'),
//! Empty Scene Node
ESNT_EMPTY = MAKE_IRR_ID('e','m','t','y'),
ESNT_EMPTY = MAKE_IRR_ID('e', 'm', 't', 'y'),
//! Dummy Transformation Scene Node
ESNT_DUMMY_TRANSFORMATION = MAKE_IRR_ID('d','m','m','y'),
ESNT_DUMMY_TRANSFORMATION = MAKE_IRR_ID('d', 'm', 'm', 'y'),
//! Camera Scene Node
ESNT_CAMERA = MAKE_IRR_ID('c','a','m','_'),
ESNT_CAMERA = MAKE_IRR_ID('c', 'a', 'm', '_'),
//! Billboard Scene Node
ESNT_BILLBOARD = MAKE_IRR_ID('b','i','l','l'),
ESNT_BILLBOARD = MAKE_IRR_ID('b', 'i', 'l', 'l'),
//! Animated Mesh Scene Node
ESNT_ANIMATED_MESH = MAKE_IRR_ID('a','m','s','h'),
ESNT_ANIMATED_MESH = MAKE_IRR_ID('a', 'm', 's', 'h'),
//! Unknown scene node
ESNT_UNKNOWN = MAKE_IRR_ID('u','n','k','n'),
ESNT_UNKNOWN = MAKE_IRR_ID('u', 'n', 'k', 'n'),
//! Will match with any scene node when checking types
ESNT_ANY = MAKE_IRR_ID('a','n','y','_')
};
ESNT_ANY = MAKE_IRR_ID('a', 'n', 'y', '_')
};
} // end namespace scene
} // end namespace irr

13
include/EShaderTypes.h
View File

@ -23,7 +23,7 @@ enum E_VERTEX_SHADER_TYPE
};
//! Names for all vertex shader types, each entry corresponds to a E_VERTEX_SHADER_TYPE entry.
const c8* const VERTEX_SHADER_TYPE_NAMES[] = {
const c8 *const VERTEX_SHADER_TYPE_NAMES[] = {
"vs_1_1",
"vs_2_0",
"vs_2_a",
@ -31,7 +31,7 @@ const c8* const VERTEX_SHADER_TYPE_NAMES[] = {
"vs_4_0",
"vs_4_1",
"vs_5_0",
0 };
0};
//! Compile target enumeration for the addHighLevelShaderMaterial() method.
enum E_PIXEL_SHADER_TYPE
@ -53,7 +53,7 @@ enum E_PIXEL_SHADER_TYPE
};
//! Names for all pixel shader types, each entry corresponds to a E_PIXEL_SHADER_TYPE entry.
const c8* const PIXEL_SHADER_TYPE_NAMES[] = {
const c8 *const PIXEL_SHADER_TYPE_NAMES[] = {
"ps_1_1",
"ps_1_2",
"ps_1_3",
@ -65,7 +65,7 @@ const c8* const PIXEL_SHADER_TYPE_NAMES[] = {
"ps_4_0",
"ps_4_1",
"ps_5_0",
0 };
0};
//! Enum for supported geometry shader types
enum E_GEOMETRY_SHADER_TYPE
@ -77,10 +77,9 @@ enum E_GEOMETRY_SHADER_TYPE
};
//! String names for supported geometry shader types
const c8* const GEOMETRY_SHADER_TYPE_NAMES[] = {
const c8 *const GEOMETRY_SHADER_TYPE_NAMES[] = {
"gs_4_0",
0 };
0};
} // end namespace video
} // end namespace irr

7
include/EVertexAttributes.h
View File

@ -19,8 +19,8 @@ enum E_VERTEX_ATTRIBUTES
};
//! Array holding the built in vertex attribute names
const char* const sBuiltInVertexAttributeNames[] =
{
const char *const sBuiltInVertexAttributeNames[] =
{
"inVertexPosition",
"inVertexNormal",
"inVertexColor",
@ -28,8 +28,7 @@ const char* const sBuiltInVertexAttributeNames[] =
"inTexCoord1",
"inVertexTangent",
"inVertexBinormal",
0
};
0};
} // end namespace video
} // end namespace irr

23
include/IAnimatedMesh.h
View File

@ -11,15 +11,14 @@ namespace irr
{
namespace scene
{
//! Interface for an animated mesh.
/** There are already simple implementations of this interface available so
you don't have to implement this interface on your own if you need to:
You might want to use irr::scene::SAnimatedMesh, irr::scene::SMesh,
irr::scene::SMeshBuffer etc. */
class IAnimatedMesh : public IMesh
{
public:
//! Interface for an animated mesh.
/** There are already simple implementations of this interface available so
you don't have to implement this interface on your own if you need to:
You might want to use irr::scene::SAnimatedMesh, irr::scene::SMesh,
irr::scene::SMeshBuffer etc. */
class IAnimatedMesh : public IMesh
{
public:
//! Gets the frame count of the animated mesh.
/** Note that the play-time is usually getFrameCount()-1 as it stops as soon as the last frame-key is reached.
\return The amount of frames. If the amount is 1,
@ -37,7 +36,7 @@ namespace scene
animation with by default. If the amount is 0,
it is not animated. The actual speed is set in the
scene node the mesh is instantiated in.*/
virtual void setAnimationSpeed(f32 fps) =0;
virtual void setAnimationSpeed(f32 fps) = 0;
//! Returns the IMesh interface for a frame.
/** \param frame: Frame number as zero based index. The maximum
@ -52,7 +51,7 @@ namespace scene
If startFrameLoop and endFrameLoop are both -1, they are ignored.
\param endFrameLoop: see startFrameLoop.
\return Returns the animated mesh based on a detail level. */
virtual IMesh* getMesh(s32 frame, s32 detailLevel=255, s32 startFrameLoop=-1, s32 endFrameLoop=-1) = 0;
virtual IMesh *getMesh(s32 frame, s32 detailLevel = 255, s32 startFrameLoop = -1, s32 endFrameLoop = -1) = 0;
//! Returns the type of the animated mesh.
/** In most cases it is not necessary to use this method.
@ -64,7 +63,7 @@ namespace scene
{
return EAMT_UNKNOWN;
}
};
};
} // end namespace scene
} // end namespace irr

74
include/IAnimatedMeshSceneNode.h
View File

@ -12,8 +12,8 @@ namespace irr
{
namespace scene
{
enum E_JOINT_UPDATE_ON_RENDER
{
enum E_JOINT_UPDATE_ON_RENDER
{
//! do nothing
EJUOR_NONE = 0,
@ -22,38 +22,35 @@ namespace scene
//! control joint positions in the mesh (eg. ragdolls, or set the animation from animateJoints() )
EJUOR_CONTROL
};
};
class IAnimatedMeshSceneNode;
class IAnimatedMeshSceneNode;
//! Callback interface for catching events of ended animations.
/** Implement this interface and use
IAnimatedMeshSceneNode::setAnimationEndCallback to be able to
be notified if an animation playback has ended.
**/
class IAnimationEndCallBack : public virtual IReferenceCounted
{
public:
//! Callback interface for catching events of ended animations.
/** Implement this interface and use
IAnimatedMeshSceneNode::setAnimationEndCallback to be able to
be notified if an animation playback has ended.
**/
class IAnimationEndCallBack : public virtual IReferenceCounted
{
public:
//! Will be called when the animation playback has ended.
/** See IAnimatedMeshSceneNode::setAnimationEndCallback for
more information.
\param node: Node of which the animation has ended. */
virtual void OnAnimationEnd(IAnimatedMeshSceneNode* node) = 0;
};
//! Scene node capable of displaying an animated mesh.
class IAnimatedMeshSceneNode : public ISceneNode
{
public:
virtual void OnAnimationEnd(IAnimatedMeshSceneNode *node) = 0;
};
//! Scene node capable of displaying an animated mesh.
class IAnimatedMeshSceneNode : public ISceneNode
{
public:
//! Constructor
IAnimatedMeshSceneNode(ISceneNode* parent, ISceneManager* mgr, s32 id,
const core::vector3df& position = core::vector3df(0,0,0),
const core::vector3df& rotation = core::vector3df(0,0,0),
const core::vector3df& scale = core::vector3df(1.0f, 1.0f, 1.0f))
: ISceneNode(parent, mgr, id, position, rotation, scale) {}
IAnimatedMeshSceneNode(ISceneNode *parent, ISceneManager *mgr, s32 id,
const core::vector3df &position = core::vector3df(0, 0, 0),
const core::vector3df &rotation = core::vector3df(0, 0, 0),
const core::vector3df &scale = core::vector3df(1.0f, 1.0f, 1.0f)) :
ISceneNode(parent, mgr, id, position, rotation, scale) {}
//! Destructor
virtual ~IAnimatedMeshSceneNode() {}
@ -82,7 +79,7 @@ namespace scene
//! Gets the speed with which the animation is played.
/** \return Frames per second played. */
virtual f32 getAnimationSpeed() const =0;
virtual f32 getAnimationSpeed() const = 0;
//! Get a pointer to a joint in the mesh (if the mesh is a bone based mesh).
/** With this method it is possible to attach scene nodes to
@ -99,10 +96,10 @@ namespace scene
\return Pointer to the scene node which represents the joint
with the specified name. Returns 0 if the contained mesh is not
an skinned mesh or the name of the joint could not be found. */
virtual IBoneSceneNode* getJointNode(const c8* jointName)=0;
virtual IBoneSceneNode *getJointNode(const c8 *jointName) = 0;
//! same as getJointNode(const c8* jointName), but based on id
virtual IBoneSceneNode* getJointNode(u32 jointID) = 0;
virtual IBoneSceneNode *getJointNode(u32 jointID) = 0;
//! Gets joint count.
/** \return Amount of joints in the mesh. */
@ -127,7 +124,7 @@ namespace scene
/** Set this to 0 to disable the callback again.
Please note that this will only be called when in non looped
mode, see IAnimatedMeshSceneNode::setLoopMode(). */
virtual void setAnimationEndCallback(IAnimationEndCallBack* callback=0) = 0;
virtual void setAnimationEndCallback(IAnimationEndCallBack *callback = 0) = 0;
//! Sets if the scene node should not copy the materials of the mesh but use them in a read only style.
/** In this way it is possible to change the materials a mesh
@ -139,35 +136,34 @@ namespace scene
virtual bool isReadOnlyMaterials() const = 0;
//! Sets a new mesh
virtual void setMesh(IAnimatedMesh* mesh) = 0;
virtual void setMesh(IAnimatedMesh *mesh) = 0;
//! Returns the current mesh
virtual IAnimatedMesh* getMesh(void) = 0;
virtual IAnimatedMesh *getMesh(void) = 0;
//! Set how the joints should be updated on render
virtual void setJointMode(E_JOINT_UPDATE_ON_RENDER mode)=0;
virtual void setJointMode(E_JOINT_UPDATE_ON_RENDER mode) = 0;
//! Sets the transition time in seconds
/** Note: This needs to enable joints, and setJointmode set to
EJUOR_CONTROL. You must call animateJoints(), or the mesh will
not animate. */
virtual void setTransitionTime(f32 Time) =0;
virtual void setTransitionTime(f32 Time) = 0;
//! animates the joints in the mesh based on the current frame.
/** Also takes in to account transitions. */
virtual void animateJoints(bool CalculateAbsolutePositions=true) = 0;
virtual void animateJoints(bool CalculateAbsolutePositions = true) = 0;
//! render mesh ignoring its transformation.
/** Culling is unaffected. */
virtual void setRenderFromIdentity( bool On )=0;
virtual void setRenderFromIdentity(bool On) = 0;
//! Creates a clone of this scene node and its children.
/** \param newParent An optional new parent.
\param newManager An optional new scene manager.
\return The newly created clone of this node. */
virtual ISceneNode* clone(ISceneNode* newParent=0, ISceneManager* newManager=0) = 0;
};
virtual ISceneNode *clone(ISceneNode *newParent = 0, ISceneManager *newManager = 0) = 0;
};
} // end namespace scene
} // end namespace irr

32
include/IAttributes.h
View File

@ -14,7 +14,7 @@ namespace irr
{
namespace video
{
class ITexture;
class ITexture;
} // end namespace video
namespace io
{
@ -23,32 +23,30 @@ namespace io
class IAttributes : public virtual IReferenceCounted
{
public:
//! Returns amount of attributes in this collection of attributes.
virtual u32 getAttributeCount() const = 0;
//! Returns attribute name by index.
//! \param index: Index value, must be between 0 and getAttributeCount()-1.
virtual const c8* getAttributeName(s32 index) const = 0;
virtual const c8 *getAttributeName(s32 index) const = 0;
//! Returns the type of an attribute
//! \param attributeName: Name for the attribute
virtual E_ATTRIBUTE_TYPE getAttributeType(const c8* attributeName) const = 0;
virtual E_ATTRIBUTE_TYPE getAttributeType(const c8 *attributeName) const = 0;
//! Returns attribute type by index.
//! \param index: Index value, must be between 0 and getAttributeCount()-1.
virtual E_ATTRIBUTE_TYPE getAttributeType(s32 index) const = 0;
//! Returns if an attribute with a name exists
virtual bool existsAttribute(const c8* attributeName) const = 0;
virtual bool existsAttribute(const c8 *attributeName) const = 0;
//! Returns attribute index from name, -1 if not found
virtual s32 findAttribute(const c8* attributeName) const = 0;
virtual s32 findAttribute(const c8 *attributeName) const = 0;
//! Removes all attributes
virtual void clear() = 0;
/*
Integer Attribute
@ -56,16 +54,16 @@ public:
*/
//! Adds an attribute as integer
virtual void addInt(const c8* attributeName, s32 value) = 0;
virtual void addInt(const c8 *attributeName, s32 value) = 0;
//! Sets an attribute as integer value
virtual void setAttribute(const c8* attributeName, s32 value) = 0;
virtual void setAttribute(const c8 *attributeName, s32 value) = 0;
//! Gets an attribute as integer value
//! \param attributeName: Name of the attribute to get.
//! \param defaultNotFound Value returned when attributeName was not found
//! \return Returns value of the attribute previously set by setAttribute()
virtual s32 getAttributeAsInt(const c8* attributeName, irr::s32 defaultNotFound=0) const = 0;
virtual s32 getAttributeAsInt(const c8 *attributeName, irr::s32 defaultNotFound = 0) const = 0;
//! Gets an attribute as integer value
//! \param index: Index value, must be between 0 and getAttributeCount()-1.
@ -81,16 +79,16 @@ public:
*/
//! Adds an attribute as float
virtual void addFloat(const c8* attributeName, f32 value) = 0;
virtual void addFloat(const c8 *attributeName, f32 value) = 0;
//! Sets a attribute as float value
virtual void setAttribute(const c8* attributeName, f32 value) = 0;
virtual void setAttribute(const c8 *attributeName, f32 value) = 0;
//! Gets an attribute as float value
//! \param attributeName: Name of the attribute to get.
//! \param defaultNotFound Value returned when attributeName was not found
//! \return Returns value of the attribute previously set by setAttribute()
virtual f32 getAttributeAsFloat(const c8* attributeName, irr::f32 defaultNotFound=0.f) const = 0;
virtual f32 getAttributeAsFloat(const c8 *attributeName, irr::f32 defaultNotFound = 0.f) const = 0;
//! Gets an attribute as float value
//! \param index: Index value, must be between 0 and getAttributeCount()-1.
@ -99,22 +97,21 @@ public:
//! Sets an attribute as float value
virtual void setAttribute(s32 index, f32 value) = 0;
/*
Bool Attribute
*/
//! Adds an attribute as bool
virtual void addBool(const c8* attributeName, bool value) = 0;
virtual void addBool(const c8 *attributeName, bool value) = 0;
//! Sets an attribute as boolean value
virtual void setAttribute(const c8* attributeName, bool value) = 0;
virtual void setAttribute(const c8 *attributeName, bool value) = 0;
//! Gets an attribute as boolean value
//! \param attributeName: Name of the attribute to get.
//! \param defaultNotFound Value returned when attributeName was not found
//! \return Returns value of the attribute previously set by setAttribute()
virtual bool getAttributeAsBool(const c8* attributeName, bool defaultNotFound=false) const = 0;
virtual bool getAttributeAsBool(const c8 *attributeName, bool defaultNotFound = false) const = 0;
//! Gets an attribute as boolean value
//! \param index: Index value, must be between 0 and getAttributeCount()-1.
@ -122,7 +119,6 @@ public:
//! Sets an attribute as boolean value
virtual void setAttribute(s32 index, bool value) = 0;
};
} // end namespace io

31
include/IBillboardSceneNode.h
View File

@ -10,8 +10,8 @@ namespace irr
{
namespace scene
{
class ICameraSceneNode;
class IMeshBuffer;
class ICameraSceneNode;
class IMeshBuffer;
//! A billboard scene node.
/** A billboard is like a 3d sprite: A 2d element,
@ -21,14 +21,13 @@ lensflares, particles and things like that.
class IBillboardSceneNode : public ISceneNode
{
public:
//! Constructor
IBillboardSceneNode(ISceneNode* parent, ISceneManager* mgr, s32 id,
const core::vector3df& position = core::vector3df(0,0,0))
: ISceneNode(parent, mgr, id, position) {}
IBillboardSceneNode(ISceneNode *parent, ISceneManager *mgr, s32 id,
const core::vector3df &position = core::vector3df(0, 0, 0)) :
ISceneNode(parent, mgr, id, position) {}
//! Sets the size of the billboard, making it rectangular.
virtual void setSize(const core::dimension2d<f32>& size) = 0;
virtual void setSize(const core::dimension2d<f32> &size) = 0;
//! Sets the size of the billboard with independent widths of the bottom and top edges.
/** \param[in] height The height of the billboard.
@ -42,30 +41,30 @@ public:
Use getWidths() to retrieve the bottom and top edges independently.
\return Size of the billboard.
*/
virtual const core::dimension2d<f32>& getSize() const = 0;
virtual const core::dimension2d<f32> &getSize() const = 0;
//! Gets the size of the the billboard and handles independent top and bottom edge widths correctly.
/** \param[out] height The height of the billboard.
\param[out] bottomEdgeWidth The width of the bottom edge of the billboard.
\param[out] topEdgeWidth The width of the top edge of the billboard.
*/
virtual void getSize(f32& height, f32& bottomEdgeWidth, f32& topEdgeWidth) const =0;
virtual void getSize(f32 &height, f32 &bottomEdgeWidth, f32 &topEdgeWidth) const = 0;
//! Set the color of all vertices of the billboard
/** \param[in] overallColor Color to set */
virtual void setColor(const video::SColor& overallColor) = 0;
virtual void setColor(const video::SColor &overallColor) = 0;
//! Set the color of the top and bottom vertices of the billboard
/** \param[in] topColor Color to set the top vertices
\param[in] bottomColor Color to set the bottom vertices */
virtual void setColor(const video::SColor& topColor,
const video::SColor& bottomColor) = 0;
virtual void setColor(const video::SColor &topColor,
const video::SColor &bottomColor) = 0;
//! Gets the color of the top and bottom vertices of the billboard
/** \param[out] topColor Stores the color of the top vertices
\param[out] bottomColor Stores the color of the bottom vertices */
virtual void getColor(video::SColor& topColor,
video::SColor& bottomColor) const = 0;
virtual void getColor(video::SColor &topColor,
video::SColor &bottomColor) const = 0;
//! Get the real boundingbox used by the billboard, which can depend on the active camera.
/** The boundingbox returned will use absolute coordinates.
@ -73,7 +72,7 @@ public:
So we don't know the real boundingboxes before that. Which would be too late for culling.
That is why the usual getBoundingBox will return a "safe" boundingbox which is guaranteed
to contain the billboard. While this function can return the real one. */
virtual const core::aabbox3d<f32>& getTransformedBillboardBoundingBox(const irr::scene::ICameraSceneNode* camera) = 0;
virtual const core::aabbox3d<f32> &getTransformedBillboardBoundingBox(const irr::scene::ICameraSceneNode *camera) = 0;
//! Get the amount of mesh buffers.
/** \return Amount of mesh buffers (IMeshBuffer) in this mesh. */
@ -84,7 +83,7 @@ public:
So this is mainly useful to access/modify the uv-coordinates.
\param nr: Zero based index of the mesh buffer.
\return Pointer to the mesh buffer or 0 if there is no such mesh buffer. */
virtual IMeshBuffer* getMeshBuffer(u32 nr) const = 0;
virtual IMeshBuffer *getMeshBuffer(u32 nr) const = 0;
};
} // end namespace scene

57
include/IBoneSceneNode.h
View File

@ -11,11 +11,11 @@ namespace irr
namespace scene
{
//! Enumeration for different bone animation modes
enum E_BONE_ANIMATION_MODE
{
//! Enumeration for different bone animation modes
enum E_BONE_ANIMATION_MODE
{
//! The bone is usually animated, unless it's parent is not animated
EBAM_AUTOMATIC=0,
EBAM_AUTOMATIC = 0,
//! The bone is animated by the skin, if it's parent is not animated then animation will resume from this bone onward
EBAM_ANIMATED,
@ -26,37 +26,35 @@ namespace scene
//! Not an animation mode, just here to count the available modes
EBAM_COUNT
};
};
enum E_BONE_SKINNING_SPACE
{
enum E_BONE_SKINNING_SPACE
{
//! local skinning, standard
EBSS_LOCAL=0,
EBSS_LOCAL = 0,
//! global skinning
EBSS_GLOBAL,
EBSS_COUNT
};
};
//! Names for bone animation modes
const c8* const BoneAnimationModeNames[] =
//! Names for bone animation modes
const c8 *const BoneAnimationModeNames[] =
{
"automatic",
"animated",
"unanimated",
0,
};
};
//! Interface for bones used for skeletal animation.
/** Used with ISkinnedMesh and IAnimatedMeshSceneNode. */
class IBoneSceneNode : public ISceneNode
{
public:
IBoneSceneNode(ISceneNode* parent, ISceneManager* mgr, s32 id=-1) :
ISceneNode(parent, mgr, id),positionHint(-1),scaleHint(-1),rotationHint(-1) { }
//! Interface for bones used for skeletal animation.
/** Used with ISkinnedMesh and IAnimatedMeshSceneNode. */
class IBoneSceneNode : public ISceneNode
{
public:
IBoneSceneNode(ISceneNode *parent, ISceneManager *mgr, s32 id = -1) :
ISceneNode(parent, mgr, id), positionHint(-1), scaleHint(-1), rotationHint(-1) {}
//! Get the index of the bone
virtual u32 getBoneIndex() const = 0;
@ -69,32 +67,31 @@ namespace scene
virtual E_BONE_ANIMATION_MODE getAnimationMode() const = 0;
//! Get the axis aligned bounding box of this node
const core::aabbox3d<f32>& getBoundingBox() const override = 0;
const core::aabbox3d<f32> &getBoundingBox() const override = 0;
//! Returns the relative transformation of the scene node.
//virtual core::matrix4 getRelativeTransformation() const = 0;
// virtual core::matrix4 getRelativeTransformation() const = 0;
//! The animation method.
void OnAnimate(u32 timeMs) override =0;
void OnAnimate(u32 timeMs) override = 0;
//! The render method.
/** Does nothing as bones are not visible. */
void render() override { }
void render() override {}
//! How the relative transformation of the bone is used
virtual void setSkinningSpace( E_BONE_SKINNING_SPACE space ) =0;
virtual void setSkinningSpace(E_BONE_SKINNING_SPACE space) = 0;
//! How the relative transformation of the bone is used
virtual E_BONE_SKINNING_SPACE getSkinningSpace() const =0;
virtual E_BONE_SKINNING_SPACE getSkinningSpace() const = 0;
//! Updates the absolute position based on the relative and the parents position
virtual void updateAbsolutePositionOfAllChildren()=0;
virtual void updateAbsolutePositionOfAllChildren() = 0;
s32 positionHint;
s32 scaleHint;
s32 rotationHint;
};
};
} // end namespace scene
} // end namespace irr

87
include/ICameraSceneNode.h
View File

@ -11,24 +11,24 @@ namespace irr
{
namespace scene
{
struct SViewFrustum;
//! Scene Node which is a (controllable) camera.
/** The whole scene will be rendered from the cameras point of view.
Because the ICameraSceneNode is a SceneNode, it can be attached to any
other scene node, and will follow its parents movement, rotation and so
on.
*/
class ICameraSceneNode : public ISceneNode, public IEventReceiver
{
public:
struct SViewFrustum;
//! Scene Node which is a (controllable) camera.
/** The whole scene will be rendered from the cameras point of view.
Because the ICameraSceneNode is a SceneNode, it can be attached to any
other scene node, and will follow its parents movement, rotation and so
on.
*/
class ICameraSceneNode : public ISceneNode, public IEventReceiver
{
public:
//! Constructor
ICameraSceneNode(ISceneNode* parent, ISceneManager* mgr, s32 id,
const core::vector3df& position = core::vector3df(0,0,0),
const core::vector3df& rotation = core::vector3df(0,0,0),
const core::vector3df& scale = core::vector3df(1.0f,1.0f,1.0f))
: ISceneNode(parent, mgr, id, position, rotation, scale), IsOrthogonal(false) {}
ICameraSceneNode(ISceneNode *parent, ISceneManager *mgr, s32 id,
const core::vector3df &position = core::vector3df(0, 0, 0),
const core::vector3df &rotation = core::vector3df(0, 0, 0),
const core::vector3df &scale = core::vector3df(1.0f, 1.0f, 1.0f)) :
ISceneNode(parent, mgr, id, position, rotation, scale),
IsOrthogonal(false) {}
//! Sets the projection matrix of the camera.
/** The core::matrix4 class has some methods to build a
@ -43,26 +43,26 @@ namespace scene
\param isOrthogonal Set this to true if the matrix is an
orthogonal one (e.g. from matrix4::buildProjectionMatrixOrtho).
*/
virtual void setProjectionMatrix(const core::matrix4& projection, bool isOrthogonal=false) =0;
virtual void setProjectionMatrix(const core::matrix4 &projection, bool isOrthogonal = false) = 0;
//! Gets the current projection matrix of the camera.
/** \return The current projection matrix of the camera. */
virtual const core::matrix4& getProjectionMatrix() const =0;
virtual const core::matrix4 &getProjectionMatrix() const = 0;
//! Gets the current view matrix of the camera.
/** \return The current view matrix of the camera. */
virtual const core::matrix4& getViewMatrix() const =0;
virtual const core::matrix4 &getViewMatrix() const = 0;
//! Sets a custom view matrix affector.
/** The matrix passed here, will be multiplied with the view
matrix when it gets updated. This allows for custom camera
setups like, for example, a reflection camera.
\param affector The affector matrix. */
virtual void setViewMatrixAffector(const core::matrix4& affector) =0;
virtual void setViewMatrixAffector(const core::matrix4 &affector) = 0;
//! Get the custom view matrix affector.
/** \return The affector matrix. */
virtual const core::matrix4& getViewMatrixAffector() const =0;
virtual const core::matrix4 &getViewMatrixAffector() const = 0;
//! It is possible to send mouse and key events to the camera.
/** Most cameras may ignore this input, but camera scene nodes
@ -71,7 +71,7 @@ namespace scene
ISceneManager::addCameraSceneNodeFPS, may want to get
this input for changing their position, look at target or
whatever. */
bool OnEvent(const SEvent& event) override =0;
bool OnEvent(const SEvent &event) override = 0;
//! Sets the look at target of the camera
/** If the camera's target and rotation are bound ( @see
@ -81,7 +81,7 @@ namespace scene
internally, so if you changed setPosition since last rendering you must
call updateAbsolutePosition before using this function.
\param pos Look at target of the camera, in world co-ordinates. */
virtual void setTarget(const core::vector3df& pos) =0;
virtual void setTarget(const core::vector3df &pos) = 0;
//! Sets the rotation of the node.
/** This only modifies the relative rotation of the node.
@ -89,63 +89,63 @@ namespace scene
bindTargetAndRotation() ) then calling this will also change
the camera's target to match the rotation.
\param rotation New rotation of the node in degrees. */
void setRotation(const core::vector3df& rotation) override =0;
void setRotation(const core::vector3df &rotation) override = 0;
//! Gets the current look at target of the camera
/** \return The current look at target of the camera, in world co-ordinates */
virtual const core::vector3df& getTarget() const =0;
virtual const core::vector3df &getTarget() const = 0;
//! Sets the up vector of the camera.
/** \param pos: New upvector of the camera. */
virtual void setUpVector(const core::vector3df& pos) =0;
virtual void setUpVector(const core::vector3df &pos) = 0;
//! Gets the up vector of the camera.
/** \return The up vector of the camera, in world space. */
virtual const core::vector3df& getUpVector() const =0;
virtual const core::vector3df &getUpVector() const = 0;
//! Gets the value of the near plane of the camera.
/** \return The value of the near plane of the camera. */
virtual f32 getNearValue() const =0;
virtual f32 getNearValue() const = 0;
//! Gets the value of the far plane of the camera.
/** \return The value of the far plane of the camera. */
virtual f32 getFarValue() const =0;
virtual f32 getFarValue() const = 0;
//! Gets the aspect ratio of the camera.
/** \return The aspect ratio of the camera. */
virtual f32 getAspectRatio() const =0;
virtual f32 getAspectRatio() const = 0;
//! Gets the field of view of the camera.
/** \return The field of view of the camera in radians. */
virtual f32 getFOV() const =0;
virtual f32 getFOV() const = 0;
//! Sets the value of the near clipping plane. (default: 1.0f)
/** \param zn: New z near value. */
virtual void setNearValue(f32 zn) =0;
virtual void setNearValue(f32 zn) = 0;
//! Sets the value of the far clipping plane (default: 2000.0f)
/** \param zf: New z far value. */
virtual void setFarValue(f32 zf) =0;
virtual void setFarValue(f32 zf) = 0;
//! Sets the aspect ratio (default: 4.0f / 3.0f)
/** \param aspect: New aspect ratio. */
virtual void setAspectRatio(f32 aspect) =0;
virtual void setAspectRatio(f32 aspect) = 0;
//! Sets the field of view (Default: PI / 2.5f)
/** \param fovy: New field of view in radians. */
virtual void setFOV(f32 fovy) =0;
virtual void setFOV(f32 fovy) = 0;
//! Get the view frustum.
/** \return The current view frustum. */
virtual const SViewFrustum* getViewFrustum() const =0;
virtual const SViewFrustum *getViewFrustum() const = 0;
//! Disables or enables the camera to get key or mouse inputs.
/** If this is set to true, the camera will respond to key
inputs otherwise not. */
virtual void setInputReceiverEnabled(bool enabled) =0;
virtual void setInputReceiverEnabled(bool enabled) = 0;
//! Checks if the input receiver of the camera is currently enabled.
virtual bool isInputReceiverEnabled() const =0;
virtual bool isInputReceiverEnabled() const = 0;
//! Checks if a camera is orthogonal.
virtual bool isOrthogonal() const
@ -162,24 +162,23 @@ namespace scene
\param bound True to bind the camera's scene node rotation
and targeting, false to unbind them.
@see getTargetAndRotationBinding() */
virtual void bindTargetAndRotation(bool bound) =0;
virtual void bindTargetAndRotation(bool bound) = 0;
//! Updates the matrices without uploading them to the driver
virtual void updateMatrices() = 0;
//! Queries if the camera scene node's rotation and its target position are bound together.
/** @see bindTargetAndRotation() */
virtual bool getTargetAndRotationBinding(void) const =0;
virtual bool getTargetAndRotationBinding(void) const = 0;
protected:
void cloneMembers(const ICameraSceneNode* toCopyFrom)
protected:
void cloneMembers(const ICameraSceneNode *toCopyFrom)
{
IsOrthogonal = toCopyFrom->IsOrthogonal;
}
bool IsOrthogonal;
};
};
} // end namespace scene
} // end namespace irr

32
include/IContextManager.h
View File

@ -12,30 +12,30 @@ namespace irr
{
namespace video
{
// For system specific window contexts (used for OpenGL)
class IContextManager : public virtual IReferenceCounted
{
public:
// For system specific window contexts (used for OpenGL)
class IContextManager : public virtual IReferenceCounted
{
public:
//! Initialize manager with device creation parameters and device window (passed as exposed video data)
virtual bool initialize(const SIrrlichtCreationParameters& params, const SExposedVideoData& data) =0;
virtual bool initialize(const SIrrlichtCreationParameters &params, const SExposedVideoData &data) = 0;
//! Terminate manager, any cleanup that is left over. Manager needs a new initialize to be usable again
virtual void terminate() =0;
virtual void terminate() = 0;
//! Create surface based on current window set
virtual bool generateSurface() =0;
virtual bool generateSurface() = 0;
//! Destroy current surface
virtual void destroySurface() =0;
virtual void destroySurface() = 0;
//! Create context based on current surface
virtual bool generateContext() =0;
virtual bool generateContext() = 0;
//! Destroy current context
virtual void destroyContext() =0;
virtual void destroyContext() = 0;
//! Get current context
virtual const SExposedVideoData& getContext() const =0;
virtual const SExposedVideoData &getContext() const = 0;
//! Change render context, disable old and activate new defined by videoData
//\param restorePrimaryOnZero When true: restore original driver context when videoData is set to 0 values.
@ -46,16 +46,14 @@ namespace video
Old thread gives up context with: activateContext(irr::video::SExposedVideoData());
New thread takes over context with: activateContext(videoDriver->getExposedVideoData());
Note that only 1 thread at a time may access an OpenGL context. */
virtual bool activateContext(const SExposedVideoData& videoData, bool restorePrimaryOnZero=false) =0;
virtual bool activateContext(const SExposedVideoData &videoData, bool restorePrimaryOnZero = false) = 0;
//! Get the address of any OpenGL procedure (including core procedures).
virtual void* getProcAddress(const std::string &procName) =0;
virtual void *getProcAddress(const std::string &procName) = 0;
//! Swap buffers.
virtual bool swapBuffers() =0;
};
virtual bool swapBuffers() = 0;
};
} // end namespace video
} // end namespace irr

69
include/ICursorControl.h
View File

@ -13,11 +13,11 @@ namespace irr
namespace gui
{
class IGUISpriteBank;
class IGUISpriteBank;
//! Default icons for cursors
enum ECURSOR_ICON
{
//! Default icons for cursors
enum ECURSOR_ICON
{
// Following cursors might be system specific, or might use an Irrlicht icon-set. No guarantees so far.
ECI_NORMAL, // arrow
ECI_CROSS, // Crosshair
@ -38,10 +38,10 @@ namespace gui
// additionally.
ECI_COUNT // maximal of defined cursors. Note that higher values can be created at runtime
};
};
//! Names for ECURSOR_ICON
const c8* const GUICursorIconNames[ECI_COUNT+1] =
//! Names for ECURSOR_ICON
const c8 *const GUICursorIconNames[ECI_COUNT + 1] =
{
"normal",
"cross",
@ -56,30 +56,29 @@ namespace gui
"sizens",
"sizewe",
"sizeup",
0
};
0};
//! structure used to set sprites as cursors.
struct SCursorSprite
{
SCursorSprite()
: SpriteBank(0), SpriteId(-1)
//! structure used to set sprites as cursors.
struct SCursorSprite
{
SCursorSprite() :
SpriteBank(0), SpriteId(-1)
{
}
SCursorSprite( gui::IGUISpriteBank * spriteBank, s32 spriteId, const core::position2d<s32> &hotspot=(core::position2d<s32>(0,0)) )
: SpriteBank(spriteBank), SpriteId(spriteId), HotSpot(hotspot)
SCursorSprite(gui::IGUISpriteBank *spriteBank, s32 spriteId, const core::position2d<s32> &hotspot = (core::position2d<s32>(0, 0))) :
SpriteBank(spriteBank), SpriteId(spriteId), HotSpot(hotspot)
{
}
IGUISpriteBank * SpriteBank;
IGUISpriteBank *SpriteBank;
s32 SpriteId;
core::position2d<s32> HotSpot;
};
};
//! platform specific behavior flags for the cursor
enum ECURSOR_PLATFORM_BEHAVIOR
{
//! platform specific behavior flags for the cursor
enum ECURSOR_PLATFORM_BEHAVIOR
{
//! default - no platform specific behavior
ECPB_NONE = 0,
@ -90,13 +89,12 @@ namespace gui
http://irrlicht.sourceforge.net/forum/viewtopic.php?f=7&t=45525
*/
ECPB_X11_CACHE_UPDATES = 1
};
//! Interface to manipulate the mouse cursor.
class ICursorControl : public virtual IReferenceCounted
{
public:
};
//! Interface to manipulate the mouse cursor.
class ICursorControl : public virtual IReferenceCounted
{
public:
//! Changes the visible state of the mouse cursor.
/** \param visible: The new visible state. If true, the cursor will be visible,
if false, it will be invisible. */
@ -138,7 +136,7 @@ namespace gui
check what has become of a setPosition call with float numbers).
\return Returns the current position of the cursor. The returned position
is the position of the mouse cursor in pixel units. */
virtual const core::position2d<s32>& getPosition(bool updateCursor=true) = 0;
virtual const core::position2d<s32> &getPosition(bool updateCursor = true) = 0;
//! Returns the current position of the mouse cursor.
/** \param updateCursor When true ask system/OS for current cursor position.
@ -149,7 +147,7 @@ namespace gui
is a value between (0.0f, 0.0f) and (1.0f, 1.0f), where (0.0f, 0.0f) is
the top left corner and (1.0f, 1.0f) is the bottom right corner of the
render window. */
virtual core::position2d<f32> getRelativePosition(bool updateCursor=true) = 0;
virtual core::position2d<f32> getRelativePosition(bool updateCursor = true) = 0;
//! Sets an absolute reference rect for setting and retrieving the cursor position.
/** If this rect is set, the cursor position is not being calculated relative to
@ -157,11 +155,11 @@ namespace gui
this feature again. This feature is useful when rendering into parts of foreign windows
for example in an editor.
\param rect: A pointer to an reference rectangle or 0 to disable the reference rectangle.*/
virtual void setReferenceRect(core::rect<s32>* rect=0) = 0;
virtual void setReferenceRect(core::rect<s32> *rect = 0) = 0;
//! Internally fixes the mouse position, and reports relative mouse movement compared to the old position
/** Specific to SDL */
virtual void setRelativeMode(bool relative) {};
virtual void setRelativeMode(bool relative){};
//! Sets the active cursor icon
/** Setting cursor icons is so far only supported on Win32 and Linux */
@ -172,17 +170,17 @@ namespace gui
//! Add a custom sprite as cursor icon.
/** \return Identification for the icon */
virtual ECURSOR_ICON addIcon(const gui::SCursorSprite& icon) { return gui::ECI_NORMAL; }
virtual ECURSOR_ICON addIcon(const gui::SCursorSprite &icon) { return gui::ECI_NORMAL; }
//! replace a cursor icon.
/** Changing cursor icons is so far only supported on Win32 and Linux
Note that this only changes the icons within your application, system cursors outside your
application will not be affected.
*/
virtual void changeIcon(ECURSOR_ICON iconId, const gui::SCursorSprite& sprite) {}
virtual void changeIcon(ECURSOR_ICON iconId, const gui::SCursorSprite &sprite) {}
//! Return a system-specific size which is supported for cursors. Larger icons will fail, smaller icons might work.
virtual core::dimension2di getSupportedIconSize() const { return core::dimension2di(0,0); }
virtual core::dimension2di getSupportedIconSize() const { return core::dimension2di(0, 0); }
//! Set platform specific behavior flags.
virtual void setPlatformBehavior(ECURSOR_PLATFORM_BEHAVIOR behavior) {}
@ -191,8 +189,7 @@ namespace gui
/** \return Behavior set by setPlatformBehavior or ECPB_NONE for platforms not implementing specific behaviors.
*/
virtual ECURSOR_PLATFORM_BEHAVIOR getPlatformBehavior() const { return ECPB_NONE; }
};
};
} // end namespace gui
} // end namespace irr

7
include/IDummyTransformationSceneNode.h
View File

@ -22,15 +22,14 @@ joint scene nodes when playing skeletal animations.
class IDummyTransformationSceneNode : public ISceneNode
{
public:
//! Constructor
IDummyTransformationSceneNode(ISceneNode* parent, ISceneManager* mgr, s32 id)
: ISceneNode(parent, mgr, id) {}
IDummyTransformationSceneNode(ISceneNode *parent, ISceneManager *mgr, s32 id) :
ISceneNode(parent, mgr, id) {}
//! Returns a reference to the current relative transformation matrix.
/** This is the matrix, this scene node uses instead of scale, translation
and rotation. */
virtual core::matrix4& getRelativeTransformationMatrix() = 0;
virtual core::matrix4 &getRelativeTransformationMatrix() = 0;
};
} // end namespace scene

96
include/IEventReceiver.h
View File

@ -10,9 +10,9 @@
namespace irr
{
//! Enumeration for all event types there are.
enum EEVENT_TYPE
{
//! Enumeration for all event types there are.
enum EEVENT_TYPE
{
//! An event of the graphical user interface.
/** GUI events are created by the GUI environment or the GUI elements in response
to mouse or keyboard events. When a GUI element receives an event it will either
@ -89,11 +89,11 @@ namespace irr
//! compile these enumeration values to 32 bit.
EGUIET_FORCE_32_BIT = 0x7fffffff
};
};
//! Enumeration for all mouse input events
enum EMOUSE_INPUT_EVENT
{
//! Enumeration for all mouse input events
enum EMOUSE_INPUT_EVENT
{
//! Left mouse button was pressed down.
EMIE_LMOUSE_PRESSED_DOWN = 0,
@ -153,11 +153,11 @@ namespace irr
//! No real event. Just for convenience to get number of events
EMIE_COUNT
};
};
//! Masks for mouse button states
enum E_MOUSE_BUTTON_STATE_MASK
{
//! Masks for mouse button states
enum E_MOUSE_BUTTON_STATE_MASK
{
EMBSM_LEFT = 0x01,
EMBSM_RIGHT = 0x02,
EMBSM_MIDDLE = 0x04,
@ -169,11 +169,11 @@ namespace irr
EMBSM_EXTRA2 = 0x10,
EMBSM_FORCE_32_BIT = 0x7fffffff
};
};
//! Enumeration for all touch input events
enum ETOUCH_INPUT_EVENT
{
//! Enumeration for all touch input events
enum ETOUCH_INPUT_EVENT
{
//! Touch was pressed down.
ETIE_PRESSED_DOWN = 0,
@ -185,10 +185,10 @@ namespace irr
//! No real event. Just for convenience to get number of events
ETIE_COUNT
};
};
enum ESYSTEM_EVENT_TYPE
{
enum ESYSTEM_EVENT_TYPE
{
//! From Android command handler for native activity messages
ESET_ANDROID_CMD = 0,
@ -196,11 +196,11 @@ namespace irr
//! No real event, but to get number of event types
ESET_COUNT
};
};
//! Enumeration for a commonly used application state events (it's useful mainly for mobile devices)
enum EAPPLICATION_EVENT_TYPE
{
//! Enumeration for a commonly used application state events (it's useful mainly for mobile devices)
enum EAPPLICATION_EVENT_TYPE
{
//! The application will be resumed.
EAET_WILL_RESUME = 0,
@ -221,16 +221,16 @@ namespace irr
//! No real event, but to get number of event types.
EAET_COUNT
};
};
namespace gui
{
namespace gui
{
class IGUIElement;
class IGUIElement;
//! Enumeration for all events which are sendable by the gui system
enum EGUI_EVENT_TYPE
{
//! Enumeration for all events which are sendable by the gui system
enum EGUI_EVENT_TYPE
{
//! A gui element has lost its focus.
/** GUIEvent.Caller is losing the focus to GUIEvent.Element.
If the event is absorbed then the focus will not be changed. */
@ -305,9 +305,8 @@ namespace irr
//! No real event. Just for convenience to get number of events
EGET_COUNT
};
} // end namespace gui
};
} // end namespace gui
//! SEvents hold information about an event. See irr::IEventReceiver for details on event handling.
struct SEvent
@ -316,14 +315,13 @@ struct SEvent
struct SGUIEvent
{
//! IGUIElement who called the event
gui::IGUIElement* Caller;
gui::IGUIElement *Caller;
//! If the event has something to do with another element, it will be held here.
gui::IGUIElement* Element;
gui::IGUIElement *Element;
//! Type of GUI Event
gui::EGUI_EVENT_TYPE EventType;
};
//! Any kind of mouse event.
@ -340,10 +338,10 @@ struct SEvent
f32 Wheel;
//! True if shift was also pressed
bool Shift:1;
bool Shift : 1;
//! True if ctrl was also pressed
bool Control:1;
bool Control : 1;
//! A bitmap of button states. You can use isButtonPressed() to determine
//! if a button is pressed or not.
@ -351,13 +349,13 @@ struct SEvent
u32 ButtonStates;
//! Is the left button pressed down?
bool isLeftPressed() const { return 0 != ( ButtonStates & EMBSM_LEFT ); }
bool isLeftPressed() const { return 0 != (ButtonStates & EMBSM_LEFT); }
//! Is the right button pressed down?
bool isRightPressed() const { return 0 != ( ButtonStates & EMBSM_RIGHT ); }
bool isRightPressed() const { return 0 != (ButtonStates & EMBSM_RIGHT); }
//! Is the middle button pressed down?
bool isMiddlePressed() const { return 0 != ( ButtonStates & EMBSM_MIDDLE ); }
bool isMiddlePressed() const { return 0 != (ButtonStates & EMBSM_MIDDLE); }
//! Type of mouse event
EMOUSE_INPUT_EVENT Event;
@ -377,13 +375,13 @@ struct SEvent
u32 SystemKeyCode;
//! If not true, then the key was left up
bool PressedDown:1;
bool PressedDown : 1;
//! True if shift was also pressed
bool Shift:1;
bool Shift : 1;
//! True if ctrl was also pressed
bool Control:1;
bool Control : 1;
};
//! String input event.
@ -471,7 +469,7 @@ struct SEvent
AXIS_R, // e.g. rudder, or analog 2 stick 2 top to bottom
AXIS_U,
AXIS_V,
NUMBER_OF_AXES=18 // (please tell Irrlicht maintainers if you absolutely need more axes)
NUMBER_OF_AXES = 18 // (please tell Irrlicht maintainers if you absolutely need more axes)
};
/** A bitmap of button states. You can use IsButtonPressed() to
@ -503,7 +501,7 @@ struct SEvent
//! A helper function to check if a button is pressed.
bool IsButtonPressed(u32 button) const
{
if(button >= (u32)NUMBER_OF_BUTTONS)
if (button >= (u32)NUMBER_OF_BUTTONS)
return false;
return (ButtonStates & (1 << button)) ? true : false;
@ -514,7 +512,7 @@ struct SEvent
struct SLogEvent
{
//! Pointer to text which has been logged
const c8* Text;
const c8 *Text;
//! Log level in which the text has been logged
ELOG_LEVEL Level;
@ -572,7 +570,6 @@ struct SEvent
struct SSystemEvent SystemEvent;
struct SApplicationEvent ApplicationEvent;
};
};
//! Interface of an object which can receive events.
@ -584,7 +581,6 @@ path it takes through the system. */
class IEventReceiver
{
public:
//! Destructor
virtual ~IEventReceiver() {}
@ -594,10 +590,9 @@ public:
* Therefore your return value for all unprocessed events should be 'false'.
\return True if the event was processed.
*/
virtual bool OnEvent(const SEvent& event) = 0;
virtual bool OnEvent(const SEvent &event) = 0;
};
//! Information on a joystick, returned from @ref irr::IrrlichtDevice::activateJoysticks()
struct SJoystickInfo
{
@ -634,5 +629,4 @@ struct SJoystickInfo
} PovHat;
}; // struct SJoystickInfo
} // end namespace irr

28
include/IFileArchive.h
View File

@ -24,46 +24,45 @@ enum EFileSystemType
enum E_FILE_ARCHIVE_TYPE
{
//! A PKZIP archive
EFAT_ZIP = MAKE_IRR_ID('Z','I','P', 0),
EFAT_ZIP = MAKE_IRR_ID('Z', 'I', 'P', 0),
//! A gzip archive
EFAT_GZIP = MAKE_IRR_ID('g','z','i','p'),
EFAT_GZIP = MAKE_IRR_ID('g', 'z', 'i', 'p'),
//! An Android asset file archive
EFAT_ANDROID_ASSET = MAKE_IRR_ID('A','S','S','E'),
EFAT_ANDROID_ASSET = MAKE_IRR_ID('A', 'S', 'S', 'E'),
//! The type of this archive is unknown
EFAT_UNKNOWN = MAKE_IRR_ID('u','n','k','n')
EFAT_UNKNOWN = MAKE_IRR_ID('u', 'n', 'k', 'n')
};
//! The FileArchive manages archives and provides access to files inside them.
class IFileArchive : public virtual IReferenceCounted
{
public:
//! Opens a file based on its name
/** Creates and returns a new IReadFile for a file in the archive.
\param filename The file to open
\return Returns A pointer to the created file on success,
or 0 on failure. */
virtual IReadFile* createAndOpenFile(const path& filename) =0;
virtual IReadFile *createAndOpenFile(const path &filename) = 0;
//! Opens a file based on its position in the file list.
/** Creates and returns
\param index The zero based index of the file.
\return Returns a pointer to the created file on success, or 0 on failure. */
virtual IReadFile* createAndOpenFile(u32 index) =0;
virtual IReadFile *createAndOpenFile(u32 index) = 0;
//! Returns the complete file tree
/** \return Returns the complete directory tree for the archive,
including all files and folders */
virtual const IFileList* getFileList() const =0;
virtual const IFileList *getFileList() const = 0;
//! get the archive type
virtual E_FILE_ARCHIVE_TYPE getType() const { return EFAT_UNKNOWN; }
//! return the name (id) of the file Archive
virtual const io::path& getArchiveName() const =0;
virtual const io::path &getArchiveName() const = 0;
//! Add a directory in the archive and all it's files to the FileList
/** Only needed for file-archives which have no information about their own
@ -95,35 +94,34 @@ public:
/** Check based on the file extension (e.g. ".zip")
\param filename Name of file to check.
\return True if file seems to be loadable. */
virtual bool isALoadableFileFormat(const path& filename) const =0;
virtual bool isALoadableFileFormat(const path &filename) const = 0;
//! Check if the file might be loaded by this class
/** This check may look into the file.
\param file File handle to check.
\return True if file seems to be loadable. */
virtual bool isALoadableFileFormat(io::IReadFile* file) const =0;
virtual bool isALoadableFileFormat(io::IReadFile *file) const = 0;
//! Check to see if the loader can create archives of this type.
/** Check based on the archive type.
\param fileType The archive type to check.
\return True if the archive loader supports this type, false if not */
virtual bool isALoadableFileFormat(E_FILE_ARCHIVE_TYPE fileType) const =0;
virtual bool isALoadableFileFormat(E_FILE_ARCHIVE_TYPE fileType) const = 0;
//! Creates an archive from the filename
/** \param filename File to use.
\param ignoreCase Searching is performed without regarding the case
\param ignorePaths Files are searched for without checking for the directories
\return Pointer to newly created archive, or 0 upon error. */
virtual IFileArchive* createArchive(const path& filename, bool ignoreCase, bool ignorePaths) const =0;
virtual IFileArchive *createArchive(const path &filename, bool ignoreCase, bool ignorePaths) const = 0;
//! Creates an archive from the file
/** \param file File handle to use.
\param ignoreCase Searching is performed without regarding the case
\param ignorePaths Files are searched for without checking for the directories
\return Pointer to newly created archive, or 0 upon error. */
virtual IFileArchive* createArchive(io::IReadFile* file, bool ignoreCase, bool ignorePaths) const =0;
virtual IFileArchive *createArchive(io::IReadFile *file, bool ignoreCase, bool ignorePaths) const = 0;
};
} // end namespace io
} // end namespace irr

10
include/IFileList.h
View File

@ -27,13 +27,13 @@ public:
\param index is the zero based index of the file which name should
be returned. The index must be less than the amount getFileCount() returns.
\return File name of the file. Returns 0, if an error occurred. */
virtual const io::path& getFileName(u32 index) const = 0;
virtual const io::path &getFileName(u32 index) const = 0;
//! Gets the full name of a file in the list including the path, based on an index.
/** \param index is the zero based index of the file which name should
be returned. The index must be less than the amount getFileCount() returns.
\return File name of the file. Returns 0 if an error occurred. */
virtual const io::path& getFullFileName(u32 index) const = 0;
virtual const io::path &getFullFileName(u32 index) const = 0;
//! Returns the size of a file in the file list, based on an index.
/** \param index is the zero based index of the file which should be returned.
@ -68,10 +68,10 @@ public:
\param isFolder True if you are searching for a directory path, false if you are searching for a file
\return Returns the index of the file in the file list, or -1 if
no matching name name was found. */
virtual s32 findFile(const io::path& filename, bool isFolder=false) const = 0;
virtual s32 findFile(const io::path &filename, bool isFolder = false) const = 0;
//! Returns the base path of the file list
virtual const io::path& getPath() const = 0;
virtual const io::path &getPath() const = 0;
//! Add as a file or folder to the list
/** \param fullPath The file name including path, from the root of the file list.
@ -79,7 +79,7 @@ public:
\param offset The file offset inside an archive
\param size The size of the file in bytes.
\param id The ID of the file in the archive which owns it */
virtual u32 addItem(const io::path& fullPath, u32 offset, u32 size, bool isDirectory, u32 id=0) = 0;
virtual u32 addItem(const io::path &fullPath, u32 offset, u32 size, bool isDirectory, u32 id = 0) = 0;
//! Sorts the file list. You should call this after adding any items to the file list
virtual void sort() = 0;

78
include/IFileSystem.h
View File

@ -11,7 +11,7 @@ namespace irr
{
namespace video
{
class IVideoDriver;
class IVideoDriver;
} // end namespace video
namespace io
{
@ -21,7 +21,6 @@ class IWriteFile;
class IFileList;
class IAttributes;
//! The FileSystem manages files and archives and provides access to them.
/** It manages where files are, so that modules which use the the IO do not
need to know where every file is located. A file could be in a .zip-Archive or
@ -29,13 +28,12 @@ as file on disk, using the IFileSystem makes no difference to this. */
class IFileSystem : public virtual IReferenceCounted
{
public:
//! Opens a file for read access.
/** \param filename: Name of file to open.
\return Pointer to the created file interface.
The returned pointer should be dropped when no longer needed.
See IReferenceCounted::drop() for more information. */
virtual IReadFile* createAndOpenFile(const path& filename) =0;
virtual IReadFile *createAndOpenFile(const path &filename) = 0;
//! Creates an IReadFile interface for accessing memory like a file.
/** This allows you to use a pointer to memory where an IReadFile is requested.
@ -48,7 +46,7 @@ public:
The returned pointer should be dropped when no longer needed.
See IReferenceCounted::drop() for more information.
*/
virtual IReadFile* createMemoryReadFile(const void* memory, s32 len, const path& fileName, bool deleteMemoryWhenDropped=false) =0;
virtual IReadFile *createMemoryReadFile(const void *memory, s32 len, const path &fileName, bool deleteMemoryWhenDropped = false) = 0;
//! Creates an IReadFile interface for accessing files inside files.
/** This is useful e.g. for archives.
@ -60,8 +58,8 @@ public:
The returned pointer should be dropped when no longer needed.
See IReferenceCounted::drop() for more information.
*/
virtual IReadFile* createLimitReadFile(const path& fileName,
IReadFile* alreadyOpenedFile, long pos, long areaSize) =0;
virtual IReadFile *createLimitReadFile(const path &fileName,
IReadFile *alreadyOpenedFile, long pos, long areaSize) = 0;
//! Creates an IWriteFile interface for accessing memory like a file.
/** This allows you to use a pointer to memory where an IWriteFile is requested.
@ -75,8 +73,7 @@ public:
The returned pointer should be dropped when no longer needed.
See IReferenceCounted::drop() for more information.
*/
virtual IWriteFile* createMemoryWriteFile(void* memory, s32 len, const path& fileName, bool deleteMemoryWhenDropped=false) =0;
virtual IWriteFile *createMemoryWriteFile(void *memory, s32 len, const path &fileName, bool deleteMemoryWhenDropped = false) = 0;
//! Opens a file for write access.
/** \param filename: Name of file to open.
@ -86,7 +83,7 @@ public:
file could not created or opened for writing.
The returned pointer should be dropped when no longer needed.
See IReferenceCounted::drop() for more information. */
virtual IWriteFile* createAndWriteFile(const path& filename, bool append=false) =0;
virtual IWriteFile *createAndWriteFile(const path &filename, bool append = false) = 0;
//! Adds an archive to the file system.
/** After calling this, the Irrlicht Engine will also search and open
@ -110,11 +107,11 @@ public:
\param password An optional password, which is used in case of encrypted archives.
\param retArchive A pointer that will be set to the archive that is added.
\return True if the archive was added successfully, false if not. */
virtual bool addFileArchive(const path& filename, bool ignoreCase=true,
bool ignorePaths=true,
E_FILE_ARCHIVE_TYPE archiveType=EFAT_UNKNOWN,
const core::stringc& password="",
IFileArchive** retArchive=0) =0;
virtual bool addFileArchive(const path &filename, bool ignoreCase = true,
bool ignorePaths = true,
E_FILE_ARCHIVE_TYPE archiveType = EFAT_UNKNOWN,
const core::stringc &password = "",
IFileArchive **retArchive = 0) = 0;
//! Adds an archive to the file system.
/** After calling this, the Irrlicht Engine will also search and open
@ -142,19 +139,19 @@ public:
\param password An optional password, which is used in case of encrypted archives.
\param retArchive A pointer that will be set to the archive that is added.
\return True if the archive was added successfully, false if not. */
virtual bool addFileArchive(IReadFile* file, bool ignoreCase=true,
bool ignorePaths=true,
E_FILE_ARCHIVE_TYPE archiveType=EFAT_UNKNOWN,
const core::stringc& password="",
IFileArchive** retArchive=0) =0;
virtual bool addFileArchive(IReadFile *file, bool ignoreCase = true,
bool ignorePaths = true,
E_FILE_ARCHIVE_TYPE archiveType = EFAT_UNKNOWN,
const core::stringc &password = "",
IFileArchive **retArchive = 0) = 0;
//! Adds an archive to the file system.
/** \param archive: The archive to add to the file system.
\return True if the archive was added successfully, false if not. */
virtual bool addFileArchive(IFileArchive* archive) =0;
virtual bool addFileArchive(IFileArchive *archive) = 0;
//! Get the number of archives currently attached to the file system
virtual u32 getFileArchiveCount() const =0;
virtual u32 getFileArchiveCount() const = 0;
//! Removes an archive from the file system.
/** This will close the archive and free any file handles, but will not
@ -162,7 +159,7 @@ public:
example textures and meshes.
\param index: The index of the archive to remove
\return True on success, false on failure */
virtual bool removeFileArchive(u32 index) =0;
virtual bool removeFileArchive(u32 index) = 0;
//! Removes an archive from the file system.
/** This will close the archive and free any file handles, but will not
@ -176,7 +173,7 @@ public:
locating the archive to work with.
\param filename The archive pointed to by the name will be removed
\return True on success, false on failure */
virtual bool removeFileArchive(const path& filename) =0;
virtual bool removeFileArchive(const path &filename) = 0;
//! Removes an archive from the file system.
/** This will close the archive and free any file handles, but will not
@ -184,21 +181,21 @@ public:
example textures and meshes.
\param archive The archive to remove.
\return True on success, false on failure */
virtual bool removeFileArchive(const IFileArchive* archive) =0;
virtual bool removeFileArchive(const IFileArchive *archive) = 0;
//! Changes the search order of attached archives.
/**
\param sourceIndex: The index of the archive to change
\param relative: The relative change in position, archives with a lower index are searched first */
virtual bool moveFileArchive(u32 sourceIndex, s32 relative) =0;
virtual bool moveFileArchive(u32 sourceIndex, s32 relative) = 0;
//! Get the archive at a given index.
virtual IFileArchive* getFileArchive(u32 index) =0;
virtual IFileArchive *getFileArchive(u32 index) = 0;
//! Adds an external archive loader to the engine.
/** Use this function to add support for new archive types to the
engine, for example proprietary or encrypted file storage. */
virtual void addArchiveLoader(IArchiveLoader* loader) =0;
virtual void addArchiveLoader(IArchiveLoader *loader) = 0;
//! Gets the number of archive loaders currently added
virtual u32 getArchiveLoaderCount() const = 0;
@ -207,63 +204,62 @@ public:
/** \param index The index of the loader to retrieve. This parameter is an 0-based
array index.
\return A pointer to the specified loader, 0 if the index is incorrect. */
virtual IArchiveLoader* getArchiveLoader(u32 index) const = 0;
virtual IArchiveLoader *getArchiveLoader(u32 index) const = 0;
//! Get the current working directory.
/** \return Current working directory as a string. */
virtual const path& getWorkingDirectory() =0;
virtual const path &getWorkingDirectory() = 0;
//! Changes the current working directory.
/** \param newDirectory: A string specifying the new working directory.
The string is operating system dependent. Under Windows it has
the form "<drive>:\<directory>\<sudirectory>\<..>". An example would be: "C:\Windows\"
\return True if successful, otherwise false. */
virtual bool changeWorkingDirectoryTo(const path& newDirectory) =0;
virtual bool changeWorkingDirectoryTo(const path &newDirectory) = 0;
//! Converts a relative path to an absolute (unique) path, resolving symbolic links if required
/** \param filename Possibly relative file or directory name to query.
\result Absolute filename which points to the same file. */
virtual path getAbsolutePath(const path& filename) const =0;
virtual path getAbsolutePath(const path &filename) const = 0;
//! Get the directory a file is located in.
/** \param filename: The file to get the directory from.
\return String containing the directory of the file. */
virtual path getFileDir(const path& filename) const =0;
virtual path getFileDir(const path &filename) const = 0;
//! Get the base part of a filename, i.e. the name without the directory part.
/** If no directory is prefixed, the full name is returned.
\param filename: The file to get the basename from
\param keepExtension True if filename with extension is returned otherwise everything
after the final '.' is removed as well. */
virtual path getFileBasename(const path& filename, bool keepExtension=true) const =0;
virtual path getFileBasename(const path &filename, bool keepExtension = true) const = 0;
//! flatten a path and file name for example: "/you/me/../." becomes "/you"
virtual path& flattenFilename(path& directory, const path& root="/") const =0;
virtual path &flattenFilename(path &directory, const path &root = "/") const = 0;
//! Get the relative filename, relative to the given directory
virtual path getRelativeFilename(const path& filename, const path& directory) const =0;
virtual path getRelativeFilename(const path &filename, const path &directory) const = 0;
//! Creates a list of files and directories in the current working directory and returns it.
/** \return a Pointer to the created IFileList is returned. After the list has been used
it has to be deleted using its IFileList::drop() method.
See IReferenceCounted::drop() for more information. */
virtual IFileList* createFileList() =0;
virtual IFileList *createFileList() = 0;
//! Creates an empty filelist
/** \return a Pointer to the created IFileList is returned. After the list has been used
it has to be deleted using its IFileList::drop() method.
See IReferenceCounted::drop() for more information. */
virtual IFileList* createEmptyFileList(const io::path& path, bool ignoreCase, bool ignorePaths) =0;
virtual IFileList *createEmptyFileList(const io::path &path, bool ignoreCase, bool ignorePaths) = 0;
//! Set the active type of file system.
virtual EFileSystemType setFileListSystem(EFileSystemType listType) =0;
virtual EFileSystemType setFileListSystem(EFileSystemType listType) = 0;
//! Determines if a file exists and could be opened.
/** \param filename is the string identifying the file which should be tested for existence.
\return True if file exists, and false if it does not exist or an error occurred. */
virtual bool existFile(const path& filename) const =0;
virtual bool existFile(const path &filename) const = 0;
};
} // end namespace io
} // end namespace irr

120
include/IGPUProgrammingServices.h
View File

@ -14,7 +14,7 @@ namespace irr
namespace io
{
class IReadFile;
class IReadFile;
} // end namespace io
namespace video
@ -27,7 +27,6 @@ class IShaderConstantSetCallBack;
class IGPUProgrammingServices
{
public:
//! Destructor
virtual ~IGPUProgrammingServices() {}
@ -73,33 +72,33 @@ public:
target is not reachable. The error strings are then printed to the
error log and can be caught with a custom event receiver. */
virtual s32 addHighLevelShaderMaterial(
const c8* vertexShaderProgram,
const c8* vertexShaderEntryPointName,
const c8 *vertexShaderProgram,
const c8 *vertexShaderEntryPointName,
E_VERTEX_SHADER_TYPE vsCompileTarget,
const c8* pixelShaderProgram,
const c8* pixelShaderEntryPointName,
const c8 *pixelShaderProgram,
const c8 *pixelShaderEntryPointName,
E_PIXEL_SHADER_TYPE psCompileTarget,
const c8* geometryShaderProgram,
const c8* geometryShaderEntryPointName = "main",
const c8 *geometryShaderProgram,
const c8 *geometryShaderEntryPointName = "main",
E_GEOMETRY_SHADER_TYPE gsCompileTarget = EGST_GS_4_0,
scene::E_PRIMITIVE_TYPE inType = scene::EPT_TRIANGLES,
scene::E_PRIMITIVE_TYPE outType = scene::EPT_TRIANGLE_STRIP,
u32 verticesOut = 0,
IShaderConstantSetCallBack* callback = 0,
IShaderConstantSetCallBack *callback = 0,
E_MATERIAL_TYPE baseMaterial = video::EMT_SOLID,
s32 userData = 0) = 0;
//! convenience function for use without geometry shaders
s32 addHighLevelShaderMaterial(
const c8* vertexShaderProgram,
const c8* vertexShaderEntryPointName="main",
E_VERTEX_SHADER_TYPE vsCompileTarget=EVST_VS_1_1,
const c8* pixelShaderProgram=0,
const c8* pixelShaderEntryPointName="main",
E_PIXEL_SHADER_TYPE psCompileTarget=EPST_PS_1_1,
IShaderConstantSetCallBack* callback=0,
E_MATERIAL_TYPE baseMaterial=video::EMT_SOLID,
s32 userData=0)
const c8 *vertexShaderProgram,
const c8 *vertexShaderEntryPointName = "main",
E_VERTEX_SHADER_TYPE vsCompileTarget = EVST_VS_1_1,
const c8 *pixelShaderProgram = 0,
const c8 *pixelShaderEntryPointName = "main",
E_PIXEL_SHADER_TYPE psCompileTarget = EPST_PS_1_1,
IShaderConstantSetCallBack *callback = 0,
E_MATERIAL_TYPE baseMaterial = video::EMT_SOLID,
s32 userData = 0)
{
return addHighLevelShaderMaterial(
vertexShaderProgram, vertexShaderEntryPointName,
@ -115,11 +114,11 @@ public:
type 1.1.
*/
s32 addHighLevelShaderMaterial(
const c8* vertexShaderProgram,
const c8* pixelShaderProgram=0,
IShaderConstantSetCallBack* callback=0,
const c8 *vertexShaderProgram,
const c8 *pixelShaderProgram = 0,
IShaderConstantSetCallBack *callback = 0,
E_MATERIAL_TYPE baseMaterial = video::EMT_SOLID,
s32 userData=0)
s32 userData = 0)
{
return addHighLevelShaderMaterial(
vertexShaderProgram, "main",
@ -135,15 +134,15 @@ public:
type 1.1 and geometry shader 4.0.
*/
s32 addHighLevelShaderMaterial(
const c8* vertexShaderProgram,
const c8* pixelShaderProgram = 0,
const c8* geometryShaderProgram = 0,
const c8 *vertexShaderProgram,
const c8 *pixelShaderProgram = 0,
const c8 *geometryShaderProgram = 0,
scene::E_PRIMITIVE_TYPE inType = scene::EPT_TRIANGLES,
scene::E_PRIMITIVE_TYPE outType = scene::EPT_TRIANGLE_STRIP,
u32 verticesOut = 0,
IShaderConstantSetCallBack* callback = 0,
IShaderConstantSetCallBack *callback = 0,
E_MATERIAL_TYPE baseMaterial = video::EMT_SOLID,
s32 userData = 0 )
s32 userData = 0)
{
return addHighLevelShaderMaterial(
vertexShaderProgram, "main",
@ -197,31 +196,31 @@ public:
target is not reachable. The error strings are then printed to the
error log and can be caught with a custom event receiver. */
virtual s32 addHighLevelShaderMaterialFromFiles(
const io::path& vertexShaderProgramFileName,
const c8* vertexShaderEntryPointName,
const io::path &vertexShaderProgramFileName,
const c8 *vertexShaderEntryPointName,
E_VERTEX_SHADER_TYPE vsCompileTarget,
const io::path& pixelShaderProgramFileName,
const c8* pixelShaderEntryPointName,
const io::path &pixelShaderProgramFileName,
const c8 *pixelShaderEntryPointName,
E_PIXEL_SHADER_TYPE psCompileTarget,
const io::path& geometryShaderProgramFileName,
const c8* geometryShaderEntryPointName = "main",
const io::path &geometryShaderProgramFileName,
const c8 *geometryShaderEntryPointName = "main",
E_GEOMETRY_SHADER_TYPE gsCompileTarget = EGST_GS_4_0,
scene::E_PRIMITIVE_TYPE inType = scene::EPT_TRIANGLES,
scene::E_PRIMITIVE_TYPE outType = scene::EPT_TRIANGLE_STRIP,
u32 verticesOut = 0,
IShaderConstantSetCallBack* callback = 0,
IShaderConstantSetCallBack *callback = 0,
E_MATERIAL_TYPE baseMaterial = video::EMT_SOLID,
s32 userData = 0) = 0;
//! convenience function for use without geometry shaders
s32 addHighLevelShaderMaterialFromFiles(
const io::path& vertexShaderProgramFileName,
const c8* vertexShaderEntryPointName = "main",
const io::path &vertexShaderProgramFileName,
const c8 *vertexShaderEntryPointName = "main",
E_VERTEX_SHADER_TYPE vsCompileTarget = EVST_VS_1_1,
const io::path& pixelShaderProgramFileName = "",
const c8* pixelShaderEntryPointName = "main",
const io::path &pixelShaderProgramFileName = "",
const c8 *pixelShaderEntryPointName = "main",
E_PIXEL_SHADER_TYPE psCompileTarget = EPST_PS_1_1,
IShaderConstantSetCallBack* callback = 0,
IShaderConstantSetCallBack *callback = 0,
E_MATERIAL_TYPE baseMaterial = video::EMT_SOLID,
s32 userData = 0)
{
@ -239,11 +238,11 @@ public:
type 1.1.
*/
s32 addHighLevelShaderMaterialFromFiles(
const io::path& vertexShaderProgramFileName,
const io::path& pixelShaderProgramFileName = "",
IShaderConstantSetCallBack* callback = 0,
const io::path &vertexShaderProgramFileName,
const io::path &pixelShaderProgramFileName = "",
IShaderConstantSetCallBack *callback = 0,
E_MATERIAL_TYPE baseMaterial = video::EMT_SOLID,
s32 userData = 0 )
s32 userData = 0)
{
return addHighLevelShaderMaterialFromFiles(
vertexShaderProgramFileName, "main",
@ -259,15 +258,15 @@ public:
type 1.1 and geometry shader 4.0.
*/
s32 addHighLevelShaderMaterialFromFiles(
const io::path& vertexShaderProgramFileName,
const io::path& pixelShaderProgramFileName = "",
const io::path& geometryShaderProgramFileName = "",
const io::path &vertexShaderProgramFileName,
const io::path &pixelShaderProgramFileName = "",
const io::path &geometryShaderProgramFileName = "",
scene::E_PRIMITIVE_TYPE inType = scene::EPT_TRIANGLES,
scene::E_PRIMITIVE_TYPE outType = scene::EPT_TRIANGLE_STRIP,
u32 verticesOut = 0,
IShaderConstantSetCallBack* callback = 0,
IShaderConstantSetCallBack *callback = 0,
E_MATERIAL_TYPE baseMaterial = video::EMT_SOLID,
s32 userData = 0 )
s32 userData = 0)
{
return addHighLevelShaderMaterialFromFiles(
vertexShaderProgramFileName, "main",
@ -319,31 +318,31 @@ public:
compile target is not reachable. The error strings are then printed to
the error log and can be caught with a custom event receiver. */
virtual s32 addHighLevelShaderMaterialFromFiles(
io::IReadFile* vertexShaderProgram,
const c8* vertexShaderEntryPointName,
io::IReadFile *vertexShaderProgram,
const c8 *vertexShaderEntryPointName,
E_VERTEX_SHADER_TYPE vsCompileTarget,
io::IReadFile* pixelShaderProgram,
const c8* pixelShaderEntryPointName,
io::IReadFile *pixelShaderProgram,
const c8 *pixelShaderEntryPointName,
E_PIXEL_SHADER_TYPE psCompileTarget,
io::IReadFile* geometryShaderProgram,
const c8* geometryShaderEntryPointName = "main",
io::IReadFile *geometryShaderProgram,
const c8 *geometryShaderEntryPointName = "main",
E_GEOMETRY_SHADER_TYPE gsCompileTarget = EGST_GS_4_0,
scene::E_PRIMITIVE_TYPE inType = scene::EPT_TRIANGLES,
scene::E_PRIMITIVE_TYPE outType = scene::EPT_TRIANGLE_STRIP,
u32 verticesOut = 0,
IShaderConstantSetCallBack* callback = 0,
IShaderConstantSetCallBack *callback = 0,
E_MATERIAL_TYPE baseMaterial = video::EMT_SOLID,
s32 userData = 0) = 0;
//! convenience function for use without geometry shaders
s32 addHighLevelShaderMaterialFromFiles(
io::IReadFile* vertexShaderProgram,
const c8* vertexShaderEntryPointName = "main",
io::IReadFile *vertexShaderProgram,
const c8 *vertexShaderEntryPointName = "main",
E_VERTEX_SHADER_TYPE vsCompileTarget = EVST_VS_1_1,
io::IReadFile* pixelShaderProgram = 0,
const c8* pixelShaderEntryPointName = "main",
io::IReadFile *pixelShaderProgram = 0,
const c8 *pixelShaderEntryPointName = "main",
E_PIXEL_SHADER_TYPE psCompileTarget = EPST_PS_1_1,
IShaderConstantSetCallBack* callback = 0,
IShaderConstantSetCallBack *callback = 0,
E_MATERIAL_TYPE baseMaterial = video::EMT_SOLID,
s32 userData = 0)
{
@ -366,6 +365,5 @@ public:
virtual void deleteShaderMaterial(s32 material) = 0;
};
} // end namespace video
} // end namespace irr

105
include/IGUIButton.h
View File

@ -11,23 +11,23 @@ namespace irr
namespace video
{
class ITexture;
class ITexture;
} // end namespace video
namespace gui
{
class IGUIFont;
class IGUISpriteBank;
class IGUIFont;
class IGUISpriteBank;
//! Current state of buttons used for drawing sprites.
//! Note that up to 3 states can be active at the same time:
//! EGBS_BUTTON_UP or EGBS_BUTTON_DOWN
//! EGBS_BUTTON_MOUSE_OVER or EGBS_BUTTON_MOUSE_OFF
//! EGBS_BUTTON_FOCUSED or EGBS_BUTTON_NOT_FOCUSED
enum EGUI_BUTTON_STATE
{
//! Current state of buttons used for drawing sprites.
//! Note that up to 3 states can be active at the same time:
//! EGBS_BUTTON_UP or EGBS_BUTTON_DOWN
//! EGBS_BUTTON_MOUSE_OVER or EGBS_BUTTON_MOUSE_OFF
//! EGBS_BUTTON_FOCUSED or EGBS_BUTTON_NOT_FOCUSED
enum EGUI_BUTTON_STATE
{
//! The button is not pressed.
EGBS_BUTTON_UP=0,
EGBS_BUTTON_UP = 0,
//! The button is currently pressed down.
EGBS_BUTTON_DOWN,
//! The mouse cursor is over the button
@ -42,10 +42,10 @@ namespace gui
EGBS_BUTTON_DISABLED,
//! not used, counts the number of enumerated items
EGBS_COUNT
};
};
//! Names for gui button state icons
const c8* const GUIButtonStateNames[EGBS_COUNT+1] =
//! Names for gui button state icons
const c8 *const GUIButtonStateNames[EGBS_COUNT + 1] =
{
"buttonUp",
"buttonDown",
@ -55,15 +55,15 @@ namespace gui
"buttonNotFocused",
"buttonDisabled",
0 // count
};
};
//! State of buttons used for drawing texture images.
//! Note that only a single state is active at a time
//! Also when no image is defined for a state it will use images from another state
//! and if that state is not set from the replacement for that,etc.
//! So in many cases setting EGBIS_IMAGE_UP and EGBIS_IMAGE_DOWN is sufficient.
enum EGUI_BUTTON_IMAGE_STATE
{
//! State of buttons used for drawing texture images.
//! Note that only a single state is active at a time
//! Also when no image is defined for a state it will use images from another state
//! and if that state is not set from the replacement for that,etc.
//! So in many cases setting EGBIS_IMAGE_UP and EGBIS_IMAGE_DOWN is sufficient.
enum EGUI_BUTTON_IMAGE_STATE
{
//! When no other states have images they will all use this one.
EGBIS_IMAGE_UP,
//! When not set EGBIS_IMAGE_UP is used.
@ -84,10 +84,10 @@ namespace gui
EGBIS_IMAGE_DISABLED,
//! not used, counts the number of enumerated items
EGBIS_COUNT
};
};
//! Names for gui button image states
const c8* const GUIButtonImageStateNames[EGBIS_COUNT+1] =
//! Names for gui button image states
const c8 *const GUIButtonImageStateNames[EGBIS_COUNT + 1] =
{
"Image", // not "ImageUp" as it otherwise breaks serialization of old files
"ImageUpOver",
@ -99,33 +99,32 @@ namespace gui
"ImageDownFocusedOver",
"ImageDisabled",
0 // count
};
//! GUI Button interface.
/** \par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_BUTTON_CLICKED
*/
class IGUIButton : public IGUIElement
{
public:
};
//! GUI Button interface.
/** \par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_BUTTON_CLICKED
*/
class IGUIButton : public IGUIElement
{
public:
//! constructor
IGUIButton(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
: IGUIElement(EGUIET_BUTTON, environment, parent, id, rectangle) {}
IGUIButton(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect<s32> rectangle) :
IGUIElement(EGUIET_BUTTON, environment, parent, id, rectangle) {}
//! Sets another skin independent font.
/** If this is set to zero, the button uses the font of the skin.
\param font: New font to set. */
virtual void setOverrideFont(IGUIFont* font=0) = 0;
virtual void setOverrideFont(IGUIFont *font = 0) = 0;
//! Gets the override font (if any)
/** \return The override font (may be 0) */
virtual IGUIFont* getOverrideFont(void) const = 0;
virtual IGUIFont *getOverrideFont(void) const = 0;
//! Get the font which is used right now for drawing
/** Currently this is the override font when one is set and the
font of the active skin otherwise */
virtual IGUIFont* getActiveFont() const = 0;
virtual IGUIFont *getActiveFont() const = 0;
//! Sets another color for the button text.
/** When set, this color is used instead of EGDC_BUTTON_TEXT/EGDC_GRAY_TEXT.
@ -160,38 +159,37 @@ namespace gui
\param state: One of ::EGUI_BUTTON_IMAGE_STATE
\param image: Image to be displayed or NULL to remove the image
\param sourceRect: Source rectangle on the image texture. When width or height are 0 then the full texture-size is used (default). */
virtual void setImage(EGUI_BUTTON_IMAGE_STATE state, video::ITexture* image=0, const core::rect<s32>& sourceRect=core::rect<s32>(0,0,0,0)) = 0;
virtual void setImage(EGUI_BUTTON_IMAGE_STATE state, video::ITexture *image = 0, const core::rect<s32> &sourceRect = core::rect<s32>(0, 0, 0, 0)) = 0;
//! Sets an image which should be displayed on the button when it is in normal state.
/** This is identical to calling setImage(EGBIS_IMAGE_UP, image); and might be deprecated in future revisions.
\param image: Image to be displayed */
virtual void setImage(video::ITexture* image=0) = 0;
virtual void setImage(video::ITexture *image = 0) = 0;
//! Sets a background image for the button when it is in normal state.
/** This is identical to calling setImage(EGBIS_IMAGE_UP, image, sourceRect); and might be deprecated in future revisions.
\param image: Texture containing the image to be displayed
\param sourceRect: Position in the texture, where the image is located.
When width or height are 0 then the full texture-size is used */
virtual void setImage(video::ITexture* image, const core::rect<s32>& sourceRect) = 0;
virtual void setImage(video::ITexture *image, const core::rect<s32> &sourceRect) = 0;
//! Sets a background image for the button when it is in pressed state.
/** This is identical to calling setImage(EGBIS_IMAGE_DOWN, image); and might be deprecated in future revisions.
If no images is specified for the pressed state via
setPressedImage(), this image is also drawn in pressed state.
\param image: Image to be displayed */
virtual void setPressedImage(video::ITexture* image=0) = 0;
virtual void setPressedImage(video::ITexture *image = 0) = 0;
//! Sets an image which should be displayed on the button when it is in pressed state.
/** This is identical to calling setImage(EGBIS_IMAGE_DOWN, image, sourceRect); and might be deprecated in future revisions.
\param image: Texture containing the image to be displayed
\param sourceRect: Position in the texture, where the image is located */
virtual void setPressedImage(video::ITexture* image, const core::rect<s32>& sourceRect) = 0;
virtual void setPressedImage(video::ITexture *image, const core::rect<s32> &sourceRect) = 0;
//! Sets the sprite bank used by the button
/** NOTE: The spritebank itself is _not_ serialized so far. The sprites are serialized.
Which means after loading the gui you still have to set the spritebank manually. */
virtual void setSpriteBank(IGUISpriteBank* bank=0) = 0;
virtual void setSpriteBank(IGUISpriteBank *bank = 0) = 0;
//! Sets the animated sprite for a specific button state
/** Several sprites can be drawn at the same time.
@ -204,7 +202,7 @@ namespace gui
\param loop: True if the animation should loop, false if not
\param scale: True if the sprite should scale to button size, false if not */
virtual void setSprite(EGUI_BUTTON_STATE state, s32 index,
video::SColor color=video::SColor(255,255,255,255), bool loop=false, bool scale=false) = 0;
video::SColor color = video::SColor(255, 255, 255, 255), bool loop = false, bool scale = false) = 0;
//! Get the sprite-index for the given state or -1 when no sprite is set
virtual s32 getSpriteIndex(EGUI_BUTTON_STATE state) const = 0;
@ -221,16 +219,16 @@ namespace gui
//! Sets if the button should behave like a push button.
/** Which means it can be in two states: Normal or Pressed. With a click on the button,
the user can change the state of the button. */
virtual void setIsPushButton(bool isPushButton=true) = 0;
virtual void setIsPushButton(bool isPushButton = true) = 0;
//! Sets the pressed state of the button if this is a pushbutton
virtual void setPressed(bool pressed=true) = 0;
virtual void setPressed(bool pressed = true) = 0;
//! Returns if the button is currently pressed
virtual bool isPressed() const = 0;
//! Sets if the alpha channel should be used for drawing background images on the button (default is false)
virtual void setUseAlphaChannel(bool useAlphaChannel=true) = 0;
virtual void setUseAlphaChannel(bool useAlphaChannel = true) = 0;
//! Returns if the alpha channel should be used for drawing background images on the button
virtual bool isAlphaChannelUsed() const = 0;
@ -239,13 +237,13 @@ namespace gui
virtual bool isPushButton() const = 0;
//! Sets if the button should use the skin to draw its border and button face (default is true)
virtual void setDrawBorder(bool border=true) = 0;
virtual void setDrawBorder(bool border = true) = 0;
//! Returns if the border and button face are being drawn using the skin
virtual bool isDrawingBorder() const = 0;
//! Sets if the button should scale the button images to fit
virtual void setScaleImage(bool scaleImage=true) = 0;
virtual void setScaleImage(bool scaleImage = true) = 0;
//! Checks whether the button scales the used images
virtual bool isScalingImage() const = 0;
@ -257,8 +255,7 @@ namespace gui
//! Get if the control key was pressed in last EGET_BUTTON_CLICKED event
/** Generated together with event, so info is available in the event-receiver. */
virtual bool getClickControlState() const = 0;
};
};
} // end namespace gui
} // end namespace irr

22
include/IGUICheckBox.h
View File

@ -11,17 +11,16 @@ namespace irr
namespace gui
{
//! GUI Check box interface.
/** \par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_CHECKBOX_CHANGED
*/
class IGUICheckBox : public IGUIElement
{
public:
//! GUI Check box interface.
/** \par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_CHECKBOX_CHANGED
*/
class IGUICheckBox : public IGUIElement
{
public:
//! constructor
IGUICheckBox(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
: IGUIElement(EGUIET_CHECK_BOX, environment, parent, id, rectangle) {}
IGUICheckBox(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect<s32> rectangle) :
IGUIElement(EGUIET_CHECK_BOX, environment, parent, id, rectangle) {}
//! Set if box is checked.
virtual void setChecked(bool checked) = 0;
@ -42,8 +41,7 @@ namespace gui
//! Checks if border drawing is enabled
/** \return true if border drawing is enabled, false otherwise */
virtual bool isDrawBorderEnabled() const = 0;
};
};
} // end namespace gui
} // end namespace irr

28
include/IGUIComboBox.h
View File

@ -11,32 +11,31 @@ namespace irr
namespace gui
{
//! Combobox widget
/** \par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_COMBO_BOX_CHANGED
*/
class IGUIComboBox : public IGUIElement
{
public:
//! Combobox widget
/** \par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_COMBO_BOX_CHANGED
*/
class IGUIComboBox : public IGUIElement
{
public:
//! constructor
IGUIComboBox(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
: IGUIElement(EGUIET_COMBO_BOX, environment, parent, id, rectangle) {}
IGUIComboBox(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect<s32> rectangle) :
IGUIElement(EGUIET_COMBO_BOX, environment, parent, id, rectangle) {}
//! Returns amount of items in box
virtual u32 getItemCount() const = 0;
//! Returns string of an item. the idx may be a value from 0 to itemCount-1
virtual const wchar_t* getItem(u32 idx) const = 0;
virtual const wchar_t *getItem(u32 idx) const = 0;
//! Returns item data of an item. the idx may be a value from 0 to itemCount-1
virtual u32 getItemData(u32 idx) const = 0;
//! Returns index based on item data
virtual s32 getIndexForItemData(u32 data ) const = 0;
virtual s32 getIndexForItemData(u32 data) const = 0;
//! Adds an item and returns the index of it
virtual u32 addItem(const wchar_t* text, u32 data = 0) = 0;
virtual u32 addItem(const wchar_t *text, u32 data = 0) = 0;
//! Removes an item from the combo box.
/** Warning. This will change the index of all following items */
@ -67,8 +66,7 @@ namespace gui
//! Get the maximal number of rows for the selection listbox
virtual u32 getMaxSelectionRows() const = 0;
};
};
} // end namespace gui
} // end namespace irr

34
include/IGUIEditBox.h
View File

@ -11,35 +11,34 @@ namespace irr
{
namespace gui
{
class IGUIFont;
//! Single line edit box for editing simple text.
/** \par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_EDITBOX_ENTER
\li EGET_EDITBOX_CHANGED
\li EGET_EDITBOX_MARKING_CHANGED
*/
class IGUIEditBox : public IGUIElement
{
public:
class IGUIFont;
//! Single line edit box for editing simple text.
/** \par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_EDITBOX_ENTER
\li EGET_EDITBOX_CHANGED
\li EGET_EDITBOX_MARKING_CHANGED
*/
class IGUIEditBox : public IGUIElement
{
public:
//! constructor
IGUIEditBox(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
: IGUIElement(EGUIET_EDIT_BOX, environment, parent, id, rectangle) {}
IGUIEditBox(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect<s32> rectangle) :
IGUIElement(EGUIET_EDIT_BOX, environment, parent, id, rectangle) {}
//! Sets another skin independent font.
/** If this is set to zero, the button uses the font of the skin.
\param font: New font to set. */
virtual void setOverrideFont(IGUIFont* font=0) = 0;
virtual void setOverrideFont(IGUIFont *font = 0) = 0;
//! Gets the override font (if any)
/** \return The override font (may be 0) */
virtual IGUIFont* getOverrideFont() const = 0;
virtual IGUIFont *getOverrideFont() const = 0;
//! Get the font which is used right now for drawing
/** Currently this is the override font when one is set and the
font of the active skin otherwise */
virtual IGUIFont* getActiveFont() const = 0;
virtual IGUIFont *getActiveFont() const = 0;
//! Sets another color for the text.
/** If set, the edit box does not use the EGDC_BUTTON_TEXT color defined
@ -146,8 +145,7 @@ namespace gui
//! Get the cursor blinktime
virtual irr::u32 getCursorBlinkTime() const = 0;
};
};
} // end namespace gui
} // end namespace irr

297
include/IGUIElement.h
View File

@ -25,30 +25,28 @@ namespace gui
class IGUIElement : virtual public IReferenceCounted, public IEventReceiver
{
public:
//! Constructor
IGUIElement(EGUI_ELEMENT_TYPE type, IGUIEnvironment* environment, IGUIElement* parent,
s32 id, const core::rect<s32>& rectangle)
: Parent(0), RelativeRect(rectangle), AbsoluteRect(rectangle),
IGUIElement(EGUI_ELEMENT_TYPE type, IGUIEnvironment *environment, IGUIElement *parent,
s32 id, const core::rect<s32> &rectangle) :
Parent(0),
RelativeRect(rectangle), AbsoluteRect(rectangle),
AbsoluteClippingRect(rectangle), DesiredRect(rectangle),
MaxSize(0,0), MinSize(1,1), IsVisible(true), IsEnabled(true),
MaxSize(0, 0), MinSize(1, 1), IsVisible(true), IsEnabled(true),
IsSubElement(false), NoClip(false), ID(id), IsTabStop(false), TabOrder(-1), IsTabGroup(false),
AlignLeft(EGUIA_UPPERLEFT), AlignRight(EGUIA_UPPERLEFT), AlignTop(EGUIA_UPPERLEFT), AlignBottom(EGUIA_UPPERLEFT),
Environment(environment), Type(type)
{
#ifdef _DEBUG
#ifdef _DEBUG
setDebugName("IGUIElement");
#endif
#endif
// if we were given a parent to attach to
if (parent)
{
if (parent) {
parent->addChildToEnd(this);
recalculateAbsolutePosition(true);
}
}
//! Destructor
virtual ~IGUIElement()
{
@ -58,9 +56,8 @@ public:
}
}
//! Returns parent of this element.
IGUIElement* getParent() const
IGUIElement *getParent() const
{
return Parent;
}
@ -71,14 +68,12 @@ public:
return RelativeRect;
}
//! Sets the relative rectangle of this element.
/** \param r The absolute position to set */
void setRelativePosition(const core::rect<s32>& r)
void setRelativePosition(const core::rect<s32> &r)
{
if (Parent)
{
const core::rect<s32>& r2 = Parent->getAbsolutePosition();
if (Parent) {
const core::rect<s32> &r2 = Parent->getAbsolutePosition();
core::dimension2df d((f32)(r2.getSize().Width), (f32)(r2.getSize().Height));
@ -98,7 +93,7 @@ public:
//! Sets the relative rectangle of this element, maintaining its current width and height
/** \param position The new relative position to set. Width and height will not be changed. */
void setRelativePosition(const core::position2di & position)
void setRelativePosition(const core::position2di &position)
{
const core::dimension2di mySize = RelativeRect.getSize();
const core::rect<s32> rectangle(position.X, position.Y,
@ -106,18 +101,17 @@ public:
setRelativePosition(rectangle);
}
//! Sets the relative rectangle of this element as a proportion of its parent's area.
/** \note This method used to be 'void setRelativePosition(const core::rect<f32>& r)'
\param r The rectangle to set, interpreted as a proportion of the parent's area.
Meaningful values are in the range [0...1], unless you intend this element to spill
outside its parent. */
void setRelativePositionProportional(const core::rect<f32>& r)
void setRelativePositionProportional(const core::rect<f32> &r)
{
if (!Parent)
return;
const core::dimension2di& d = Parent->getAbsolutePosition().getSize();
const core::dimension2di &d = Parent->getAbsolutePosition().getSize();
DesiredRect = core::rect<s32>(
core::floor32((f32)d.Width * r.UpperLeftCorner.X),
@ -130,21 +124,18 @@ public:
updateAbsolutePosition();
}
//! Gets the absolute rectangle of this element
core::rect<s32> getAbsolutePosition() const
{
return AbsoluteRect;
}
//! Returns the visible area of the element.
core::rect<s32> getAbsoluteClippingRect() const
{
return AbsoluteClippingRect;
}
//! Sets whether the element will ignore its parent's clipping rectangle
/** \param noClip If true, the element will not be clipped by its parent's clipping rectangle. */
void setNotClipped(bool noClip)
@ -153,7 +144,6 @@ public:
updateAbsolutePosition();
}
//! Gets whether the element will ignore its parent's clipping rectangle
/** \return true if the element is not clipped by its parent's clipping rectangle. */
bool isNotClipped() const
@ -161,7 +151,6 @@ public:
return NoClip;
}
//! Sets the maximum size allowed for this element
/** If set to 0,0, there is no maximum size */
void setMaxSize(core::dimension2du size)
@ -170,7 +159,6 @@ public:
updateAbsolutePosition();
}
//! Sets the minimum size allowed for this element
void setMinSize(core::dimension2du size)
{
@ -182,7 +170,6 @@ public:
updateAbsolutePosition();
}
//! The alignment defines how the borders of this element will be positioned when the parent element is resized.
void setAlignment(EGUI_ALIGNMENT left, EGUI_ALIGNMENT right, EGUI_ALIGNMENT top, EGUI_ALIGNMENT bottom)
{
@ -191,8 +178,7 @@ public:
AlignTop = top;
AlignBottom = bottom;
if (Parent)
{
if (Parent) {
core::rect<s32> r(Parent->getAbsolutePosition());
core::dimension2df d((f32)r.getSize().Width, (f32)r.getSize().Height);
@ -238,13 +224,11 @@ public:
recalculateAbsolutePosition(false);
// update all children
for (auto child : Children)
{
for (auto child : Children) {
child->updateAbsolutePosition();
}
}
//! Returns the topmost GUI element at the specific position.
/**
This will check this GUI element and all of its descendants, so it
@ -257,18 +241,16 @@ public:
\return The topmost GUI element at that point, or 0 if there are
no candidate elements at this point.
*/
virtual IGUIElement* getElementFromPoint(const core::position2d<s32>& point)
virtual IGUIElement *getElementFromPoint(const core::position2d<s32> &point)
{
IGUIElement* target = 0;
IGUIElement *target = 0;
if (isVisible())
{
if (isVisible()) {
// we have to search from back to front, because later children
// might be drawn over the top of earlier ones.
auto it = Children.rbegin();
auto ie = Children.rend();
while (it != ie)
{
while (it != ie) {
target = (*it)->getElementFromPoint(point);
if (target)
return target;
@ -283,27 +265,24 @@ public:
return target;
}
//! Returns true if a point is within this element.
/** Elements with a shape other than a rectangle should override this method */
virtual bool isPointInside(const core::position2d<s32>& point) const
virtual bool isPointInside(const core::position2d<s32> &point) const
{
return AbsoluteClippingRect.isPointInside(point);
}
//! Adds a GUI element as new child of this element.
virtual void addChild(IGUIElement* child)
{
if ( child && child != this )
virtual void addChild(IGUIElement *child)
{
if (child && child != this) {
addChildToEnd(child);
child->updateAbsolutePosition();
}
}
//! Removes a child.
virtual void removeChild(IGUIElement* child)
virtual void removeChild(IGUIElement *child)
{
assert(child->Parent == this);
Children.erase(child->ParentPos);
@ -312,7 +291,8 @@ public:
}
//! Removes all children.
virtual void removeAllChildren() {
virtual void removeAllChildren()
{
while (!Children.empty()) {
auto child = Children.back();
child->remove();
@ -326,36 +306,30 @@ public:
Parent->removeChild(this);
}
//! Draws the element and its children.
virtual void draw()
{
if ( isVisible() )
{
if (isVisible()) {
for (auto child : Children)
child->draw();
}
}
//! animate the element and its children.
virtual void OnPostRender(u32 timeMs)
{
if ( isVisible() )
{
if (isVisible()) {
for (auto child : Children)
child->OnPostRender( timeMs );
child->OnPostRender(timeMs);
}
}
//! Moves this element.
virtual void move(core::position2d<s32> absoluteMovement)
{
setRelativePosition(DesiredRect + absoluteMovement);
}
//! Returns true if element is visible.
virtual bool isVisible() const
{
@ -367,10 +341,10 @@ public:
false if this or any parent element is invisible. */
virtual bool isTrulyVisible() const
{
if(!IsVisible)
if (!IsVisible)
return false;
if(!Parent)
if (!Parent)
return true;
return Parent->isTrulyVisible();
@ -382,14 +356,12 @@ public:
IsVisible = visible;
}
//! Returns true if this element was created as part of its parent control
virtual bool isSubElement() const
{
return IsSubElement;
}
//! Sets whether this control was created as part of its parent.
/** For example, it is true when a scrollbar is part of a listbox.
SubElements are not saved to disk when calling guiEnvironment->saveGUI() */
@ -398,7 +370,6 @@ public:
IsSubElement = subElement;
}
//! If set to true, the focus will visit this element when using the tab key to cycle through elements.
/** If this element is a tab group (see isTabGroup/setTabGroup) then
ctrl+tab will be used instead. */
@ -407,51 +378,43 @@ public:
IsTabStop = enable;
}
//! Returns true if this element can be focused by navigating with the tab key
bool isTabStop() const
{
return IsTabStop;
}
//! Sets the priority of focus when using the tab key to navigate between a group of elements.
/** See setTabGroup, isTabGroup and getTabGroup for information on tab groups.
Elements with a lower number are focused first */
void setTabOrder(s32 index)
{
// negative = autonumber
if (index < 0)
{
if (index < 0) {
TabOrder = 0;
IGUIElement *el = getTabGroup();
while (IsTabGroup && el && el->Parent)
el = el->Parent;
IGUIElement *first=0, *closest=0;
if (el)
{
IGUIElement *first = 0, *closest = 0;
if (el) {
// find the highest element number
el->getNextElement(-1, true, IsTabGroup, first, closest, true, true);
if (first)
{
if (first) {
TabOrder = first->getTabOrder() + 1;
}
}
}
else
} else
TabOrder = index;
}
//! Returns the number in the tab order sequence
s32 getTabOrder() const
{
return TabOrder;
}
//! Sets whether this element is a container for a group of elements which can be navigated using the tab key.
/** For example, windows are tab groups.
Groups can be navigated using ctrl+tab, providing isTabStop is true. */
@ -460,18 +423,16 @@ public:
IsTabGroup = isGroup;
}
//! Returns true if this element is a tab group.
bool isTabGroup() const
{
return IsTabGroup;
}
//! Returns the container element which holds all elements in this element's tab group.
IGUIElement* getTabGroup()
IGUIElement *getTabGroup()
{
IGUIElement *ret=this;
IGUIElement *ret = this;
while (ret && !ret->isTabGroup())
ret = ret->getParent();
@ -479,7 +440,6 @@ public:
return ret;
}
//! Returns true if element is enabled
/** Currently elements do _not_ care about parent-states.
So if you want to affect children you have to enable/disable them all.
@ -487,72 +447,63 @@ public:
*/
virtual bool isEnabled() const
{
if ( isSubElement() && IsEnabled && getParent() )
if (isSubElement() && IsEnabled && getParent())
return getParent()->isEnabled();
return IsEnabled;
}
//! Sets the enabled state of this element.
virtual void setEnabled(bool enabled)
{
IsEnabled = enabled;
}
//! Sets the new caption of this element.
virtual void setText(const wchar_t* text)
virtual void setText(const wchar_t *text)
{
Text = text;
}
//! Returns caption of this element.
virtual const wchar_t* getText() const
virtual const wchar_t *getText() const
{
return Text.c_str();
}
//! Sets the new caption of this element.
virtual void setToolTipText(const wchar_t* text)
virtual void setToolTipText(const wchar_t *text)
{
ToolTipText = text;
}
//! Returns caption of this element.
virtual const core::stringw& getToolTipText() const
virtual const core::stringw &getToolTipText() const
{
return ToolTipText;
}
//! Returns id. Can be used to identify the element.
virtual s32 getID() const
{
return ID;
}
//! Sets the id of this element
virtual void setID(s32 id)
{
ID = id;
}
//! Called if an event happened.
bool OnEvent(const SEvent& event) override
bool OnEvent(const SEvent &event) override
{
return Parent ? Parent->OnEvent(event) : false;
}
//! Brings a child to front
/** \return True if successful, false if not. */
virtual bool bringToFront(IGUIElement* child)
virtual bool bringToFront(IGUIElement *child)
{
if (child->Parent != this)
return false;
@ -563,10 +514,9 @@ public:
return true;
}
//! Moves a child to the back, so it's siblings are drawn on top of it
/** \return True if successful, false if not. */
virtual bool sendToBack(IGUIElement* child)
virtual bool sendToBack(IGUIElement *child)
{
if (child->Parent != this)
return false;
@ -578,12 +528,11 @@ public:
}
//! Returns list with children of this element
virtual const std::list<IGUIElement*>& getChildren() const
virtual const std::list<IGUIElement *> &getChildren() const
{
return Children;
}
//! Finds the first element with the given id.
/** \param id: Id to search for.
\param searchchildren: Set this to true, if also children of this
@ -591,12 +540,11 @@ public:
should be searched too.
\return Returns the first element with the given id. If no element
with this id was found, 0 is returned. */
virtual IGUIElement* getElementFromId(s32 id, bool searchchildren=false) const
virtual IGUIElement *getElementFromId(s32 id, bool searchchildren = false) const
{
IGUIElement* e = 0;
IGUIElement *e = 0;
for (auto child : Children)
{
for (auto child : Children) {
if (child->getID() == id)
return child;
@ -610,25 +558,21 @@ public:
return e;
}
//! returns true if the given element is a child of this one.
//! \param child: The child element to check
bool isMyChild(IGUIElement* child) const
bool isMyChild(IGUIElement *child) const
{
if (!child)
return false;
do
{
do {
if (child->Parent)
child = child->Parent;
} while (child->Parent && child != this);
return child == this;
}
//! searches elements to find the closest next element to tab to
/** \param startOrder: The TabOrder of the current element, -1 if none
\param reverse: true if searching for a lower number
@ -639,74 +583,58 @@ public:
\param includeDisabled: includes disabled elements in the search (default=false)
\return true if successfully found an element, false to continue searching/fail */
bool getNextElement(s32 startOrder, bool reverse, bool group,
IGUIElement*& first, IGUIElement*& closest, bool includeInvisible=false,
bool includeDisabled=false) const
IGUIElement *&first, IGUIElement *&closest, bool includeInvisible = false,
bool includeDisabled = false) const
{
// we'll stop searching if we find this number
s32 wanted = startOrder + ( reverse ? -1 : 1 );
if (wanted==-2)
s32 wanted = startOrder + (reverse ? -1 : 1);
if (wanted == -2)
wanted = 1073741824; // maximum s32
auto it = Children.begin();
s32 closestOrder, currentOrder;
while(it != Children.end())
{
while (it != Children.end()) {
// ignore invisible elements and their children
if ( ( (*it)->isVisible() || includeInvisible ) &&
(group == true || (*it)->isTabGroup() == false) )
{
if (((*it)->isVisible() || includeInvisible) &&
(group == true || (*it)->isTabGroup() == false)) {
// ignore disabled, but children are checked (disabled is currently per element ignoring parent states)
if ( (*it)->isEnabled() || includeDisabled )
{
if ((*it)->isEnabled() || includeDisabled) {
// only check tab stops and those with the same group status
if ((*it)->isTabStop() && ((*it)->isTabGroup() == group))
{
if ((*it)->isTabStop() && ((*it)->isTabGroup() == group)) {
currentOrder = (*it)->getTabOrder();
// is this what we're looking for?
if (currentOrder == wanted)
{
if (currentOrder == wanted) {
closest = *it;
return true;
}
// is it closer than the current closest?
if (closest)
{
if (closest) {
closestOrder = closest->getTabOrder();
if ( ( reverse && currentOrder > closestOrder && currentOrder < startOrder)
||(!reverse && currentOrder < closestOrder && currentOrder > startOrder))
{
if ((reverse && currentOrder > closestOrder && currentOrder < startOrder) || (!reverse && currentOrder < closestOrder && currentOrder > startOrder)) {
closest = *it;
}
}
else
if ( (reverse && currentOrder < startOrder) || (!reverse && currentOrder > startOrder) )
{
} else if ((reverse && currentOrder < startOrder) || (!reverse && currentOrder > startOrder)) {
closest = *it;
}
// is it before the current first?
if (first)
{
if (first) {
closestOrder = first->getTabOrder();
if ( (reverse && closestOrder < currentOrder) || (!reverse && closestOrder > currentOrder) )
{
if ((reverse && closestOrder < currentOrder) || (!reverse && closestOrder > currentOrder)) {
first = *it;
}
}
else
{
} else {
first = *it;
}
}
}
// search within children
if ((*it)->getNextElement(startOrder, reverse, group, first, closest, includeInvisible, includeDisabled))
{
if ((*it)->getNextElement(startOrder, reverse, group, first, closest, includeInvisible, includeDisabled)) {
return true;
}
}
@ -715,7 +643,6 @@ public:
return false;
}
//! Returns the type of the gui element.
/** This is needed for the .NET wrapper but will be used
later for serializing and deserializing.
@ -740,51 +667,45 @@ public:
return type == Type;
}
//! Returns the type name of the gui element.
/** This is needed serializing elements. */
virtual const c8* getTypeName() const
virtual const c8 *getTypeName() const
{
return GUIElementTypeNames[Type];
}
//! Returns the name of the element.
/** \return Name as character string. */
virtual const c8* getName() const
virtual const c8 *getName() const
{
return Name.c_str();
}
//! Sets the name of the element.
/** \param name New name of the gui element. */
virtual void setName(const c8* name)
virtual void setName(const c8 *name)
{
Name = name;
}
//! Sets the name of the element.
/** \param name New name of the gui element. */
virtual void setName(const core::stringc& name)
virtual void setName(const core::stringc &name)
{
Name = name;
}
//! Returns whether the element takes input from the IME
virtual bool acceptsIME()
{
return false;
}
protected:
// not virtual because needed in constructor
void addChildToEnd(IGUIElement* child)
{
if (child)
void addChildToEnd(IGUIElement *child)
{
if (child) {
child->grab(); // prevent destruction when removed
child->remove(); // remove from old parent
child->LastParentRect = getAbsolutePosition();
@ -794,8 +715,9 @@ protected:
}
#ifndef NDEBUG
template<typename Iterator>
static size_t _fastSetChecksum(Iterator begin, Iterator end) {
template <typename Iterator>
static size_t _fastSetChecksum(Iterator begin, Iterator end)
{
std::hash<typename Iterator::value_type> hasher;
size_t checksum = 0;
for (Iterator it = begin; it != end; ++it) {
@ -808,13 +730,12 @@ protected:
// Reorder children [from, to) to the order given by `neworder`
void reorderChildren(
std::list<IGUIElement*>::iterator from,
std::list<IGUIElement*>::iterator to,
const std::vector<IGUIElement*> &neworder)
std::list<IGUIElement *>::iterator from,
std::list<IGUIElement *>::iterator to,
const std::vector<IGUIElement *> &neworder)
{
assert(_fastSetChecksum(from, to) == _fastSetChecksum(neworder.begin(), neworder.end()));
for (auto e : neworder)
{
for (auto e : neworder) {
*from = e;
e->ParentPos = from;
++from;
@ -822,26 +743,22 @@ protected:
assert(from == to);
}
// not virtual because needed in constructor
void recalculateAbsolutePosition(bool recursive)
{
core::rect<s32> parentAbsolute(0,0,0,0);
core::rect<s32> parentAbsolute(0, 0, 0, 0);
core::rect<s32> parentAbsoluteClip;
f32 fw=0.f, fh=0.f;
f32 fw = 0.f, fh = 0.f;
if (Parent)
{
if (Parent) {
parentAbsolute = Parent->AbsoluteRect;
if (NoClip)
{
IGUIElement* p=this;
if (NoClip) {
IGUIElement *p = this;
while (p->Parent)
p = p->Parent;
parentAbsoluteClip = p->AbsoluteClippingRect;
}
else
} else
parentAbsoluteClip = Parent->AbsoluteClippingRect;
}
@ -854,60 +771,56 @@ protected:
if (AlignTop == EGUIA_SCALE || AlignBottom == EGUIA_SCALE)
fh = (f32)parentAbsolute.getHeight();
switch (AlignLeft)
{
switch (AlignLeft) {
case EGUIA_UPPERLEFT:
break;
case EGUIA_LOWERRIGHT:
DesiredRect.UpperLeftCorner.X += diffx;
break;
case EGUIA_CENTER:
DesiredRect.UpperLeftCorner.X += diffx/2;
DesiredRect.UpperLeftCorner.X += diffx / 2;
break;
case EGUIA_SCALE:
DesiredRect.UpperLeftCorner.X = core::round32(ScaleRect.UpperLeftCorner.X * fw);
break;
}
switch (AlignRight)
{
switch (AlignRight) {
case EGUIA_UPPERLEFT:
break;
case EGUIA_LOWERRIGHT:
DesiredRect.LowerRightCorner.X += diffx;
break;
case EGUIA_CENTER:
DesiredRect.LowerRightCorner.X += diffx/2;
DesiredRect.LowerRightCorner.X += diffx / 2;
break;
case EGUIA_SCALE:
DesiredRect.LowerRightCorner.X = core::round32(ScaleRect.LowerRightCorner.X * fw);
break;
}
switch (AlignTop)
{
switch (AlignTop) {
case EGUIA_UPPERLEFT:
break;
case EGUIA_LOWERRIGHT:
DesiredRect.UpperLeftCorner.Y += diffy;
break;
case EGUIA_CENTER:
DesiredRect.UpperLeftCorner.Y += diffy/2;
DesiredRect.UpperLeftCorner.Y += diffy / 2;
break;
case EGUIA_SCALE:
DesiredRect.UpperLeftCorner.Y = core::round32(ScaleRect.UpperLeftCorner.Y * fh);
break;
}
switch (AlignBottom)
{
switch (AlignBottom) {
case EGUIA_UPPERLEFT:
break;
case EGUIA_LOWERRIGHT:
DesiredRect.LowerRightCorner.Y += diffy;
break;
case EGUIA_CENTER:
DesiredRect.LowerRightCorner.Y += diffy/2;
DesiredRect.LowerRightCorner.Y += diffy / 2;
break;
case EGUIA_SCALE:
DesiredRect.LowerRightCorner.Y = core::round32(ScaleRect.LowerRightCorner.Y * fh);
@ -941,26 +854,23 @@ protected:
LastParentRect = parentAbsolute;
if ( recursive )
{
if (recursive) {
// update all children
for (auto child : Children)
{
for (auto child : Children) {
child->recalculateAbsolutePosition(recursive);
}
}
}
protected:
//! List of all children of this element
std::list<IGUIElement*> Children;
std::list<IGUIElement *> Children;
//! Pointer to the parent
IGUIElement* Parent;
IGUIElement *Parent;
//! Our position in the parent list. Only valid when Parent != nullptr
std::list<IGUIElement*>::iterator ParentPos;
std::list<IGUIElement *>::iterator ParentPos;
//! relative rect of element
core::rect<s32> RelativeRect;
@ -1021,12 +931,11 @@ protected:
EGUI_ALIGNMENT AlignLeft, AlignRight, AlignTop, AlignBottom;
//! GUI Environment
IGUIEnvironment* Environment;
IGUIEnvironment *Environment;
//! type of element
EGUI_ELEMENT_TYPE Type;
};
} // end namespace gui
} // end namespace irr

131
include/IGUIEnvironment.h
View File

@ -13,20 +13,20 @@
namespace irr
{
class IOSOperator;
class IEventReceiver;
class IOSOperator;
class IEventReceiver;
namespace io
{
class IReadFile;
class IWriteFile;
class IFileSystem;
} // end namespace io
namespace video
{
class IVideoDriver;
class ITexture;
} // end namespace video
namespace io
{
class IReadFile;
class IWriteFile;
class IFileSystem;
} // end namespace io
namespace video
{
class IVideoDriver;
class ITexture;
} // end namespace video
namespace gui
{
@ -58,11 +58,10 @@ class IGUIWindow;
class IGUIEnvironment : public virtual IReferenceCounted
{
public:
//! Draws all gui elements by traversing the GUI environment starting at the root node.
/** \param When true ensure the GuiEnvironment (aka the RootGUIElement) has the same size as the current driver screensize.
Can be set to false to control that size yourself, p.E when not the full size should be used for UI. */
virtual void drawAll(bool useScreenSize=true) = 0;
virtual void drawAll(bool useScreenSize = true) = 0;
//! Sets the focus to an element.
/** Causes a EGET_ELEMENT_FOCUS_LOST event followed by a
@ -70,11 +69,11 @@ public:
then the focus will not be changed.
\param element Pointer to the element which shall get the focus.
\return True on success, false on failure */
virtual bool setFocus(IGUIElement* element) = 0;
virtual bool setFocus(IGUIElement *element) = 0;
//! Returns the element which holds the focus.
/** \return Pointer to the element with focus. */
virtual IGUIElement* getFocus() const = 0;
virtual IGUIElement *getFocus() const = 0;
//! Returns the element which was last under the mouse cursor
/** NOTE: This information is updated _after_ the user-eventreceiver
@ -82,32 +81,32 @@ public:
mouse events you have to use instead:
IGUIEnvironment::getRootGUIElement()->getElementFromPoint(mousePos);
\return Pointer to the element under the mouse. */
virtual IGUIElement* getHovered() const = 0;
virtual IGUIElement *getHovered() const = 0;
//! Removes the focus from an element.
/** Causes a EGET_ELEMENT_FOCUS_LOST event. If the event is absorbed
then the focus will not be changed.
\param element Pointer to the element which shall lose the focus.
\return True on success, false on failure */
virtual bool removeFocus(IGUIElement* element) = 0;
virtual bool removeFocus(IGUIElement *element) = 0;
//! Returns whether the element has focus
/** \param element Pointer to the element which is tested.
\param checkSubElements When true and focus is on a sub-element of element then it will still count as focused and return true
\return True if the element has focus, else false. */
virtual bool hasFocus(const IGUIElement* element, bool checkSubElements=false) const = 0;
virtual bool hasFocus(const IGUIElement *element, bool checkSubElements = false) const = 0;
//! Returns the current video driver.
/** \return Pointer to the video driver. */
virtual video::IVideoDriver* getVideoDriver() const = 0;
virtual video::IVideoDriver *getVideoDriver() const = 0;
//! Returns the file system.
/** \return Pointer to the file system. */
virtual io::IFileSystem* getFileSystem() const = 0;
virtual io::IFileSystem *getFileSystem() const = 0;
//! returns a pointer to the OS operator
/** \return Pointer to the OS operator. */
virtual IOSOperator* getOSOperator() const = 0;
virtual IOSOperator *getOSOperator() const = 0;
//! Removes all elements from the environment.
virtual void clear() = 0;
@ -117,17 +116,17 @@ public:
use this method, it is used by the engine internally.
\param event The event to post.
\return True if succeeded, else false. */
virtual bool postEventFromUser(const SEvent& event) = 0;
virtual bool postEventFromUser(const SEvent &event) = 0;
//! This sets a new event receiver for gui events.
/** Usually you do not have to
use this method, it is used by the engine internally.
\param evr Pointer to the new receiver. */
virtual void setUserEventReceiver(IEventReceiver* evr) = 0;
virtual void setUserEventReceiver(IEventReceiver *evr) = 0;
//! Returns pointer to the current gui skin.
/** \return Pointer to the GUI skin. */
virtual IGUISkin* getSkin() const = 0;
virtual IGUISkin *getSkin() const = 0;
//! Sets a new GUI Skin
/** You can use this to change the appearance of the whole GUI
@ -142,7 +141,7 @@ public:
\endcode
\param skin New skin to use.
*/
virtual void setSkin(IGUISkin* skin) = 0;
virtual void setSkin(IGUISkin *skin) = 0;
//! Creates a new GUI Skin based on a template.
/** Use setSkin() to set the created skin.
@ -150,8 +149,7 @@ public:
\return Pointer to the created skin.
If you no longer need it, you should call IGUISkin::drop().
See IReferenceCounted::drop() for more information. */
virtual IGUISkin* createSkin(EGUI_SKIN_TYPE type) = 0;
virtual IGUISkin *createSkin(EGUI_SKIN_TYPE type) = 0;
//! Creates the image list from the given texture.
/** \param texture Texture to split into images
@ -160,9 +158,9 @@ public:
\return Pointer to the font. Returns 0 if the font could not be loaded.
This pointer should not be dropped. See IReferenceCounted::drop() for
more information. */
virtual IGUIImageList* createImageList( video::ITexture* texture,
virtual IGUIImageList *createImageList(video::ITexture *texture,
core::dimension2d<s32> imageSize,
bool useAlphaChannel ) = 0;
bool useAlphaChannel) = 0;
//! Returns pointer to the font with the specified filename.
/** Loads the font if it was not loaded before.
@ -170,7 +168,7 @@ public:
\return Pointer to the font. Returns 0 if the font could not be loaded.
This pointer should not be dropped. See IReferenceCounted::drop() for
more information. */
virtual IGUIFont* getFont(const io::path& filename) = 0;
virtual IGUIFont *getFont(const io::path &filename) = 0;
//! Adds an externally loaded font to the font list.
/** This method allows to attach an already loaded font to the list of
@ -178,29 +176,29 @@ public:
\param name Name the font should be stored as.
\param font Pointer to font to add.
\return Pointer to the font stored. This can differ from given parameter if the name previously existed. */
virtual IGUIFont* addFont(const io::path& name, IGUIFont* font) = 0;
virtual IGUIFont *addFont(const io::path &name, IGUIFont *font) = 0;
//! remove loaded font
virtual void removeFont(IGUIFont* font) = 0;
virtual void removeFont(IGUIFont *font) = 0;
//! Returns the default built-in font.
/** \return Pointer to the default built-in font.
This pointer should not be dropped. See IReferenceCounted::drop() for
more information. */
virtual IGUIFont* getBuiltInFont() const = 0;
virtual IGUIFont *getBuiltInFont() const = 0;
//! Returns pointer to the sprite bank which was added with addEmptySpriteBank
/** TODO: This should load files in the future, but not implemented so far.
\param filename Name of a spritebank added with addEmptySpriteBank
\return Pointer to the sprite bank. Returns 0 if it could not be loaded.
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual IGUISpriteBank* getSpriteBank(const io::path& filename) = 0;
virtual IGUISpriteBank *getSpriteBank(const io::path &filename) = 0;
//! Adds an empty sprite bank to the manager
/** \param name Name of the new sprite bank.
\return Pointer to the sprite bank.
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual IGUISpriteBank* addEmptySpriteBank(const io::path& name) = 0;
virtual IGUISpriteBank *addEmptySpriteBank(const io::path &name) = 0;
//! Returns the root gui element.
/** This is the first gui element, the (direct or indirect) parent of all
@ -209,7 +207,7 @@ public:
\return Pointer to the root element of the GUI. The returned pointer
should not be dropped. See IReferenceCounted::drop() for more
information. */
virtual IGUIElement* getRootGUIElement() = 0;
virtual IGUIElement *getRootGUIElement() = 0;
//! Adds a button element.
/** \param rectangle Rectangle specifying the borders of the button.
@ -220,8 +218,8 @@ public:
\return Pointer to the created button. Returns 0 if an error occurred.
This pointer should not be dropped. See IReferenceCounted::drop() for
more information. */
virtual IGUIButton* addButton(const core::rect<s32>& rectangle,
IGUIElement* parent=0, s32 id=-1, const wchar_t* text=0, const wchar_t* tooltiptext = 0) = 0;
virtual IGUIButton *addButton(const core::rect<s32> &rectangle,
IGUIElement *parent = 0, s32 id = -1, const wchar_t *text = 0, const wchar_t *tooltiptext = 0) = 0;
//! Adds a scrollbar.
/** \param horizontal Specifies if the scroll bar is drawn horizontal
@ -232,8 +230,8 @@ public:
\return Pointer to the created scrollbar. Returns 0 if an error
occurred. This pointer should not be dropped. See
IReferenceCounted::drop() for more information. */
virtual IGUIScrollBar* addScrollBar(bool horizontal, const core::rect<s32>& rectangle,
IGUIElement* parent=0, s32 id=-1) = 0;
virtual IGUIScrollBar *addScrollBar(bool horizontal, const core::rect<s32> &rectangle,
IGUIElement *parent = 0, s32 id = -1) = 0;
//! Adds an image element.
/** \param image Image to be displayed.
@ -247,8 +245,8 @@ public:
\return Pointer to the created image element. Returns 0 if an error
occurred. This pointer should not be dropped. See
IReferenceCounted::drop() for more information. */
virtual IGUIImage* addImage(video::ITexture* image, core::position2d<s32> pos,
bool useAlphaChannel=true, IGUIElement* parent=0, s32 id=-1, const wchar_t* text=0) = 0;
virtual IGUIImage *addImage(video::ITexture *image, core::position2d<s32> pos,
bool useAlphaChannel = true, IGUIElement *parent = 0, s32 id = -1, const wchar_t *text = 0) = 0;
//! Adds an image element.
/** Use IGUIImage::setImage later to set the image to be displayed.
@ -261,8 +259,8 @@ public:
\return Pointer to the created image element. Returns 0 if an error
occurred. This pointer should not be dropped. See
IReferenceCounted::drop() for more information. */
virtual IGUIImage* addImage(const core::rect<s32>& rectangle,
IGUIElement* parent=0, s32 id=-1, const wchar_t* text=0, bool useAlphaChannel=true) = 0;
virtual IGUIImage *addImage(const core::rect<s32> &rectangle,
IGUIElement *parent = 0, s32 id = -1, const wchar_t *text = 0, bool useAlphaChannel = true) = 0;
//! Adds a checkbox element.
/** \param checked Define the initial state of the check box.
@ -273,8 +271,8 @@ public:
\return Pointer to the created check box. Returns 0 if an error
occurred. This pointer should not be dropped. See
IReferenceCounted::drop() for more information. */
virtual IGUICheckBox* addCheckBox(bool checked, const core::rect<s32>& rectangle,
IGUIElement* parent=0, s32 id=-1, const wchar_t* text=0) = 0;
virtual IGUICheckBox *addCheckBox(bool checked, const core::rect<s32> &rectangle,
IGUIElement *parent = 0, s32 id = -1, const wchar_t *text = 0) = 0;
//! Adds a list box element.
/** \param rectangle Rectangle specifying the borders of the list box.
@ -284,8 +282,8 @@ public:
\return Pointer to the created list box. Returns 0 if an error occurred.
This pointer should not be dropped. See IReferenceCounted::drop() for
more information. */
virtual IGUIListBox* addListBox(const core::rect<s32>& rectangle,
IGUIElement* parent=0, s32 id=-1, bool drawBackground=false) = 0;
virtual IGUIListBox *addListBox(const core::rect<s32> &rectangle,
IGUIElement *parent = 0, s32 id = -1, bool drawBackground = false) = 0;
//! Adds a file open dialog.
/** \param title Text to be displayed as the title of the dialog.
@ -301,9 +299,9 @@ public:
\return Pointer to the created file open dialog. Returns 0 if an error
occurred. This pointer should not be dropped. See
IReferenceCounted::drop() for more information. */
virtual IGUIFileOpenDialog* addFileOpenDialog(const wchar_t* title=0,
bool modal=true, IGUIElement* parent=0, s32 id=-1,
bool restoreCWD=false, io::path::char_type* startDir=0) = 0;
virtual IGUIFileOpenDialog *addFileOpenDialog(const wchar_t *title = 0,
bool modal = true, IGUIElement *parent = 0, s32 id = -1,
bool restoreCWD = false, io::path::char_type *startDir = 0) = 0;
//! Adds a static text.
/** \param text Text to be displayed. Can be altered after creation by SetText().
@ -317,8 +315,8 @@ public:
\return Pointer to the created static text. Returns 0 if an error
occurred. This pointer should not be dropped. See
IReferenceCounted::drop() for more information. */
virtual IGUIStaticText* addStaticText(const wchar_t* text, const core::rect<s32>& rectangle,
bool border=false, bool wordWrap=true, IGUIElement* parent=0, s32 id=-1,
virtual IGUIStaticText *addStaticText(const wchar_t *text, const core::rect<s32> &rectangle,
bool border = false, bool wordWrap = true, IGUIElement *parent = 0, s32 id = -1,
bool fillBackground = false) = 0;
//! Adds an edit box.
@ -336,8 +334,8 @@ public:
\return Pointer to the created edit box. Returns 0 if an error occurred.
This pointer should not be dropped. See IReferenceCounted::drop() for
more information. */
virtual IGUIEditBox* addEditBox(const wchar_t* text, const core::rect<s32>& rectangle,
bool border=true, IGUIElement* parent=0, s32 id=-1) = 0;
virtual IGUIEditBox *addEditBox(const wchar_t *text, const core::rect<s32> &rectangle,
bool border = true, IGUIElement *parent = 0, s32 id = -1) = 0;
//! Adds a tab control to the environment.
/** \param rectangle Rectangle specifying the borders of the tab control.
@ -352,9 +350,9 @@ public:
\return Pointer to the created tab control element. Returns 0 if an
error occurred. This pointer should not be dropped. See
IReferenceCounted::drop() for more information. */
virtual IGUITabControl* addTabControl(const core::rect<s32>& rectangle,
IGUIElement* parent=0, bool fillbackground=false,
bool border=true, s32 id=-1) = 0;
virtual IGUITabControl *addTabControl(const core::rect<s32> &rectangle,
IGUIElement *parent = 0, bool fillbackground = false,
bool border = true, s32 id = -1) = 0;
//! Adds tab to the environment.
/** You can use this element to group other elements. This is not used
@ -367,8 +365,8 @@ public:
\return Pointer to the created tab. Returns 0 if an
error occurred. This pointer should not be dropped. See
IReferenceCounted::drop() for more information. */
virtual IGUITab* addTab(const core::rect<s32>& rectangle,
IGUIElement* parent=0, s32 id=-1) = 0;
virtual IGUITab *addTab(const core::rect<s32> &rectangle,
IGUIElement *parent = 0, s32 id = -1) = 0;
//! Adds a combo box to the environment.
/** \param rectangle Rectangle specifying the borders of the combo box.
@ -378,8 +376,8 @@ public:
\return Pointer to the created combo box. Returns 0 if an
error occurred. This pointer should not be dropped. See
IReferenceCounted::drop() for more information. */
virtual IGUIComboBox* addComboBox(const core::rect<s32>& rectangle,
IGUIElement* parent=0, s32 id=-1) = 0;
virtual IGUIComboBox *addComboBox(const core::rect<s32> &rectangle,
IGUIElement *parent = 0, s32 id = -1) = 0;
//! Find the next element which would be selected when pressing the tab-key
/** If you set the focus for the result you can manually force focus-changes like they
@ -387,7 +385,7 @@ public:
\param reverse When true it will search backward (toward lower TabOrder numbers, like shift+tab)
\param group When true it will search for the next tab-group (like ctrl+tab)
*/
virtual IGUIElement* getNextElement(bool reverse=false, bool group=false) = 0;
virtual IGUIElement *getNextElement(bool reverse = false, bool group = false) = 0;
//! Set the way the gui will handle automatic focus changes
/** The default is (EFF_SET_ON_LMOUSE_DOWN | EFF_SET_ON_TAB).
@ -409,9 +407,8 @@ public:
Note that in general just calling IGUIElement::remove() is enough.
Unless you create your own GUI elements removing themselves you won't need it.
\param element: Element to remove */
virtual void addToDeletionQueue(IGUIElement* element) = 0;
virtual void addToDeletionQueue(IGUIElement *element) = 0;
};
} // end namespace gui
} // end namespace irr

36
include/IGUIFileOpenDialog.h
View File

@ -12,35 +12,33 @@ namespace irr
namespace gui
{
//! Standard file chooser dialog.
/** \warning When the user selects a folder this does change the current working directory
\par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_DIRECTORY_SELECTED
\li EGET_FILE_SELECTED
\li EGET_FILE_CHOOSE_DIALOG_CANCELLED
*/
class IGUIFileOpenDialog : public IGUIElement
{
public:
//! Standard file chooser dialog.
/** \warning When the user selects a folder this does change the current working directory
\par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_DIRECTORY_SELECTED
\li EGET_FILE_SELECTED
\li EGET_FILE_CHOOSE_DIALOG_CANCELLED
*/
class IGUIFileOpenDialog : public IGUIElement
{
public:
//! constructor
IGUIFileOpenDialog(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
: IGUIElement(EGUIET_FILE_OPEN_DIALOG, environment, parent, id, rectangle) {}
IGUIFileOpenDialog(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect<s32> rectangle) :
IGUIElement(EGUIET_FILE_OPEN_DIALOG, environment, parent, id, rectangle) {}
//! Returns the filename of the selected file converted to wide characters. Returns NULL if no file was selected.
virtual const wchar_t* getFileName() const = 0;
virtual const wchar_t *getFileName() const = 0;
//! Returns the filename of the selected file. Is empty if no file was selected.
virtual const io::path& getFileNameP() const = 0;
virtual const io::path &getFileNameP() const = 0;
//! Returns the directory of the selected file. Empty if no directory was selected.
virtual const io::path& getDirectoryName() const = 0;
virtual const io::path &getDirectoryName() const = 0;
//! Returns the directory of the selected file converted to wide characters. Returns NULL if no directory was selected.
virtual const wchar_t* getDirectoryNameW() const = 0;
};
virtual const wchar_t *getDirectoryNameW() const = 0;
};
} // end namespace gui
} // end namespace irr

19
include/IGUIFont.h
View File

@ -38,7 +38,6 @@ enum EGUI_FONT_TYPE
class IGUIFont : public virtual IReferenceCounted
{
public:
//! Draws some text and clips it to the specified rectangle if wanted.
/** \param text: Text to draw
\param position: Rectangle specifying position where to draw the text.
@ -47,30 +46,30 @@ public:
\param vcenter: Specifies if the text should be centered vertically into the rectangle.
\param clip: Optional pointer to a rectangle against which the text will be clipped.
If the pointer is null, no clipping will be done. */
virtual void draw(const core::stringw& text, const core::rect<s32>& position,
video::SColor color, bool hcenter=false, bool vcenter=false,
const core::rect<s32>* clip=0) = 0;
virtual void draw(const core::stringw &text, const core::rect<s32> &position,
video::SColor color, bool hcenter = false, bool vcenter = false,
const core::rect<s32> *clip = 0) = 0;
//! Calculates the width and height of a given string of text.
/** \return Returns width and height of the area covered by the text if
it would be drawn. */
virtual core::dimension2d<u32> getDimension(const wchar_t* text) const = 0;
virtual core::dimension2d<u32> getDimension(const wchar_t *text) const = 0;
//! Calculates the index of the character in the text which is on a specific position.
/** \param text: Text string.
\param pixel_x: X pixel position of which the index of the character will be returned.
\return Returns zero based index of the character in the text, and -1 if no no character
is on this position. (=the text is too short). */
virtual s32 getCharacterFromPos(const wchar_t* text, s32 pixel_x) const = 0;
virtual s32 getCharacterFromPos(const wchar_t *text, s32 pixel_x) const = 0;
//! Returns the type of this font
virtual EGUI_FONT_TYPE getType() const { return EGFT_CUSTOM; }
//! Sets global kerning width for the font.
virtual void setKerningWidth (s32 kerning) = 0;
virtual void setKerningWidth(s32 kerning) = 0;
//! Sets global kerning height for the font.
virtual void setKerningHeight (s32 kerning) = 0;
virtual void setKerningHeight(s32 kerning) = 0;
//! Gets kerning values (distance between letters) for the font. If no parameters are provided,
/** the global kerning distance is returned.
@ -83,7 +82,7 @@ public:
which supports kerning pairs a string such as 'Wo' may have the 'o'
tucked neatly under the 'W'.
*/
virtual s32 getKerningWidth(const wchar_t* thisLetter=0, const wchar_t* previousLetter=0) const = 0;
virtual s32 getKerningWidth(const wchar_t *thisLetter = 0, const wchar_t *previousLetter = 0) const = 0;
//! Returns the distance between letters
virtual s32 getKerningHeight() const = 0;
@ -93,7 +92,7 @@ public:
most fonts.
\param s String of symbols which are not send down to the videodriver
*/
virtual void setInvisibleCharacters( const wchar_t *s ) = 0;
virtual void setInvisibleCharacters(const wchar_t *s) = 0;
};
} // end namespace gui

7
include/IGUIFontBitmap.h
View File

@ -10,18 +10,17 @@ namespace irr
{
namespace gui
{
class IGUISpriteBank;
class IGUISpriteBank;
//! Font interface.
class IGUIFontBitmap : public IGUIFont
{
public:
//! Returns the type of this font
EGUI_FONT_TYPE getType() const override { return EGFT_BITMAP; }
//! returns the parsed Symbol Information
virtual IGUISpriteBank* getSpriteBank() const = 0;
virtual IGUISpriteBank *getSpriteBank() const = 0;
//! returns the sprite number from a given character
virtual u32 getSpriteNoFromChar(const wchar_t *c) const = 0;
@ -35,7 +34,7 @@ public:
kerning value. For example, EGFT_BITMAP will add the right kerning value of previousLetter to the
left side kerning value of thisLetter, then add the global value.
*/
s32 getKerningWidth(const wchar_t* thisLetter=0, const wchar_t* previousLetter=0) const override = 0;
s32 getKerningWidth(const wchar_t *thisLetter = 0, const wchar_t *previousLetter = 0) const override = 0;
};
} // end namespace gui

26
include/IGUIImage.h
View File

@ -10,24 +10,23 @@ namespace irr
{
namespace video
{
class ITexture;
class ITexture;
}
namespace gui
{
//! GUI element displaying an image.
class IGUIImage : public IGUIElement
{
public:
//! GUI element displaying an image.
class IGUIImage : public IGUIElement
{
public:
//! constructor
IGUIImage(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
: IGUIElement(EGUIET_IMAGE, environment, parent, id, rectangle) {}
IGUIImage(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect<s32> rectangle) :
IGUIElement(EGUIET_IMAGE, environment, parent, id, rectangle) {}
//! Sets an image texture
virtual void setImage(video::ITexture* image) = 0;
virtual void setImage(video::ITexture *image) = 0;
//! Gets the image texture
virtual video::ITexture* getImage() const = 0;
virtual video::ITexture *getImage() const = 0;
//! Sets the color of the image
/** \param color Color with which the image is drawn. If the color
@ -51,7 +50,7 @@ namespace gui
//! Sets the source rectangle of the image. By default the full image is used.
/** \param sourceRect coordinates inside the image or an area with size 0 for using the full image (default). */
virtual void setSourceRect(const core::rect<s32>& sourceRect) = 0;
virtual void setSourceRect(const core::rect<s32> &sourceRect) = 0;
//! Returns the customized source rectangle of the image to be used.
/** By default an empty rectangle of width and height 0 is returned which means the full image is used. */
@ -65,7 +64,7 @@ namespace gui
Unlike normal clipping this does not affect the gui-children.
\param drawBoundUVs: Coordinates between 0 and 1 where 0 are for left+top and 1 for right+bottom
*/
virtual void setDrawBounds(const core::rect<f32>& drawBoundUVs = core::rect<f32>(0.f, 0.f, 1.f, 1.f)) = 0;
virtual void setDrawBounds(const core::rect<f32> &drawBoundUVs = core::rect<f32>(0.f, 0.f, 1.f, 1.f)) = 0;
//! Get drawing-area restrictions.
virtual core::rect<f32> getDrawBounds() const = 0;
@ -77,8 +76,7 @@ namespace gui
//! Checks if a background is drawn when no texture is set
/** \return true if background drawing is enabled, false otherwise */
virtual bool isDrawBackgroundEnabled() const = 0;
};
};
} // end namespace gui
} // end namespace irr

7
include/IGUIImageList.h
View File

@ -16,17 +16,16 @@ namespace gui
class IGUIImageList : public virtual IReferenceCounted
{
public:
//! Destructor
virtual ~IGUIImageList() {};
virtual ~IGUIImageList(){};
//! Draws an image and clips it to the specified rectangle if wanted
//! \param index: Index of the image
//! \param destPos: Position of the image to draw
//! \param clip: Optional pointer to a rectangle against which the text will be clipped.
//! If the pointer is null, no clipping will be done.
virtual void draw(s32 index, const core::position2d<s32>& destPos,
const core::rect<s32>* clip = 0) = 0;
virtual void draw(s32 index, const core::position2d<s32> &destPos,
const core::rect<s32> *clip = 0) = 0;
//! Returns the count of Images in the list.
//! \return Returns the count of Images in the list.

52
include/IGUIListBox.h
View File

@ -11,14 +11,14 @@ namespace irr
{
namespace gui
{
class IGUISpriteBank;
class IGUIScrollBar;
class IGUISpriteBank;
class IGUIScrollBar;
//! Enumeration for listbox colors
enum EGUI_LISTBOX_COLOR
{
//! Enumeration for listbox colors
enum EGUI_LISTBOX_COLOR
{
//! Color of text
EGUI_LBC_TEXT=0,
EGUI_LBC_TEXT = 0,
//! Color of selected text
EGUI_LBC_TEXT_HIGHLIGHT,
//! Color of icon
@ -27,35 +27,34 @@ namespace gui
EGUI_LBC_ICON_HIGHLIGHT,
//! Not used, just counts the number of available colors
EGUI_LBC_COUNT
};
};
//! Default list box GUI element.
/** \par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_LISTBOX_CHANGED
\li EGET_LISTBOX_SELECTED_AGAIN
*/
class IGUIListBox : public IGUIElement
{
public:
//! Default list box GUI element.
/** \par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_LISTBOX_CHANGED
\li EGET_LISTBOX_SELECTED_AGAIN
*/
class IGUIListBox : public IGUIElement
{
public:
//! constructor
IGUIListBox(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
: IGUIElement(EGUIET_LIST_BOX, environment, parent, id, rectangle) {}
IGUIListBox(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect<s32> rectangle) :
IGUIElement(EGUIET_LIST_BOX, environment, parent, id, rectangle) {}
//! returns amount of list items
virtual u32 getItemCount() const = 0;
//! returns string of a list item. the may id be a value from 0 to itemCount-1
virtual const wchar_t* getListItem(u32 id) const = 0;
virtual const wchar_t *getListItem(u32 id) const = 0;
//! adds an list item, returns id of item
virtual u32 addItem(const wchar_t* text) = 0;
virtual u32 addItem(const wchar_t *text) = 0;
//! adds an list item with an icon
/** \param text Text of list entry
\param icon Sprite index of the Icon within the current sprite bank. Set it to -1 if you want no icon
\return The id of the new created item */
virtual u32 addItem(const wchar_t* text, s32 icon) = 0;
virtual u32 addItem(const wchar_t *text, s32 icon) = 0;
//! Removes an item from the list
virtual void removeItem(u32 index) = 0;
@ -72,7 +71,7 @@ namespace gui
default. A sprite can be displayed in front of every list item.
An icon is an index within the icon sprite bank. Several
default icons are available in the skin through getIcon. */
virtual void setSpriteBank(IGUISpriteBank* bank) = 0;
virtual void setSpriteBank(IGUISpriteBank *bank) = 0;
//! clears the list, deletes all items in the listbox
virtual void clear() = 0;
@ -114,25 +113,24 @@ namespace gui
virtual video::SColor getItemDefaultColor(EGUI_LISTBOX_COLOR colorType) const = 0;
//! set the item at the given index
virtual void setItem(u32 index, const wchar_t* text, s32 icon) = 0;
virtual void setItem(u32 index, const wchar_t *text, s32 icon) = 0;
//! Insert the item at the given index
/** \return The index on success or -1 on failure. */
virtual s32 insertItem(u32 index, const wchar_t* text, s32 icon) = 0;
virtual s32 insertItem(u32 index, const wchar_t *text, s32 icon) = 0;
//! Swap the items at the given indices
virtual void swapItems(u32 index1, u32 index2) = 0;
//! set global itemHeight
virtual void setItemHeight( s32 height ) = 0;
virtual void setItemHeight(s32 height) = 0;
//! Sets whether to draw the background
virtual void setDrawBackground(bool draw) = 0;
//! Access the vertical scrollbar
virtual IGUIScrollBar* getVerticalScrollBar() const = 0;
virtual IGUIScrollBar *getVerticalScrollBar() const = 0;
};
} // end namespace gui
} // end namespace irr

22
include/IGUIScrollBar.h
View File

@ -11,17 +11,16 @@ namespace irr
namespace gui
{
//! Default scroll bar GUI element.
/** \par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_SCROLL_BAR_CHANGED
*/
class IGUIScrollBar : public IGUIElement
{
public:
//! Default scroll bar GUI element.
/** \par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_SCROLL_BAR_CHANGED
*/
class IGUIScrollBar : public IGUIElement
{
public:
//! constructor
IGUIScrollBar(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
: IGUIElement(EGUIET_SCROLL_BAR, environment, parent, id, rectangle) {}
IGUIScrollBar(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect<s32> rectangle) :
IGUIElement(EGUIET_SCROLL_BAR, environment, parent, id, rectangle) {}
//! sets the maximum value of the scrollbar.
virtual void setMax(s32 max) = 0;
@ -54,8 +53,7 @@ namespace gui
//! sets the current position of the scrollbar
virtual void setPos(s32 pos) = 0;
};
};
} // end namespace gui
} // end namespace irr

191
include/IGUISkin.h
View File

@ -13,23 +13,23 @@ namespace irr
{
namespace gui
{
class IGUIFont;
class IGUISpriteBank;
class IGUIElement;
class IGUIFont;
class IGUISpriteBank;
class IGUIElement;
//! Enumeration of available default skins.
/** To set one of the skins, use the following code, for example to set
the Windows classic skin:
\code
gui::IGUISkin* newskin = environment->createSkin(gui::EGST_WINDOWS_CLASSIC);
environment->setSkin(newskin);
newskin->drop();
\endcode
*/
enum EGUI_SKIN_TYPE
{
//! Enumeration of available default skins.
/** To set one of the skins, use the following code, for example to set
the Windows classic skin:
\code
gui::IGUISkin* newskin = environment->createSkin(gui::EGST_WINDOWS_CLASSIC);
environment->setSkin(newskin);
newskin->drop();
\endcode
*/
enum EGUI_SKIN_TYPE
{
//! Default windows look and feel
EGST_WINDOWS_CLASSIC=0,
EGST_WINDOWS_CLASSIC = 0,
//! Like EGST_WINDOWS_CLASSIC, but with metallic shaded windows and buttons
EGST_WINDOWS_METALLIC,
@ -42,22 +42,21 @@ namespace gui
//! this value is not used, it only specifies the number of skin types
EGST_COUNT
};
};
//! Names for gui element types
const c8* const GUISkinTypeNames[EGST_COUNT+1] =
//! Names for gui element types
const c8 *const GUISkinTypeNames[EGST_COUNT + 1] =
{
"windowsClassic",
"windowsMetallic",
"burning",
"unknown",
0,
};
};
//! Enumeration for skin colors
enum EGUI_DEFAULT_COLOR
{
//! Enumeration for skin colors
enum EGUI_DEFAULT_COLOR
{
//! Dark shadow for three-dimensional display elements.
EGDC_3D_DARK_SHADOW = 0,
//! Shadow color for three-dimensional display elements (for edges facing away from the light source).
@ -112,10 +111,10 @@ namespace gui
//! this value is not used, it only specifies the amount of default colors
//! available.
EGDC_COUNT
};
};
//! Names for default skin colors
const c8* const GUISkinColorNames[EGDC_COUNT+1] =
//! Names for default skin colors
const c8 *const GUISkinColorNames[EGDC_COUNT + 1] =
{
"3DDarkShadow",
"3DShadow",
@ -143,11 +142,11 @@ namespace gui
"GrayEditable",
"FocusedEditable",
0,
};
};
//! Enumeration for default sizes.
enum EGUI_DEFAULT_SIZE
{
//! Enumeration for default sizes.
enum EGUI_DEFAULT_SIZE
{
//! default with / height of scrollbar. Also width of drop-down button in comboboxes.
EGDS_SCROLLBAR_SIZE = 0,
//! height of menu
@ -198,11 +197,10 @@ namespace gui
//! this value is not used, it only specifies the amount of default sizes
//! available.
EGDS_COUNT
};
};
//! Names for default skin sizes
const c8* const GUISkinSizeNames[EGDS_COUNT+1] =
//! Names for default skin sizes
const c8 *const GUISkinSizeNames[EGDS_COUNT + 1] =
{
"ScrollBarSize",
"MenuHeight",
@ -227,12 +225,10 @@ namespace gui
"ButtonPressedTextOffsetY",
"ButtonPressedSpriteOffsetX",
"ButtonPressedSpriteOffsetY",
0
};
0};
enum EGUI_DEFAULT_TEXT
{
enum EGUI_DEFAULT_TEXT
{
//! Text for the OK button on a message box
EGDT_MSG_BOX_OK = 0,
//! Text for the Cancel button on a message box
@ -252,10 +248,10 @@ namespace gui
//! this value is not used, it only specifies the number of default texts
EGDT_COUNT
};
};
//! Names for default skin sizes
const c8* const GUISkinTextNames[EGDT_COUNT+1] =
//! Names for default skin sizes
const c8 *const GUISkinTextNames[EGDT_COUNT + 1] =
{
"MessageBoxOkay",
"MessageBoxCancel",
@ -265,12 +261,11 @@ namespace gui
"WindowButtonMaximize",
"WindowButtonMinimize",
"WindowButtonRestore",
0
};
0};
//! Customizable symbols for GUI
enum EGUI_DEFAULT_ICON
{
//! Customizable symbols for GUI
enum EGUI_DEFAULT_ICON
{
//! maximize window button
EGDI_WINDOW_MAXIMIZE = 0,
//! restore window button
@ -321,9 +316,9 @@ namespace gui
//! value not used, it only specifies the number of icons
EGDI_COUNT
};
};
const c8* const GUISkinIconNames[EGDI_COUNT+1] =
const c8 *const GUISkinIconNames[EGDI_COUNT + 1] =
{
"windowMaximize",
"windowRestore",
@ -348,14 +343,13 @@ namespace gui
"collapse",
"file",
"directory",
0
};
0};
// Customizable fonts
enum EGUI_DEFAULT_FONT
{
// Customizable fonts
enum EGUI_DEFAULT_FONT
{
//! For static text, edit boxes, lists and most other places
EGDF_DEFAULT=0,
EGDF_DEFAULT = 0,
//! Font for buttons
EGDF_BUTTON,
//! Font for window title bars
@ -367,23 +361,21 @@ namespace gui
//! this value is not used, it only specifies the amount of default fonts
//! available.
EGDF_COUNT
};
};
const c8* const GUISkinFontNames[EGDF_COUNT+1] =
const c8 *const GUISkinFontNames[EGDF_COUNT + 1] =
{
"defaultFont",
"buttonFont",
"windowFont",
"menuFont",
"tooltipFont",
0
};
//! A skin modifies the look of the GUI elements.
class IGUISkin : virtual public IReferenceCounted
{
public:
0};
//! A skin modifies the look of the GUI elements.
class IGUISkin : virtual public IReferenceCounted
{
public:
//! returns default color
virtual video::SColor getColor(EGUI_DEFAULT_COLOR color) const = 0;
@ -396,27 +388,27 @@ namespace gui
//! Returns a default text.
/** For example for Message box button captions:
"OK", "Cancel", "Yes", "No" and so on. */
virtual const wchar_t* getDefaultText(EGUI_DEFAULT_TEXT text) const = 0;
virtual const wchar_t *getDefaultText(EGUI_DEFAULT_TEXT text) const = 0;
//! Sets a default text.
/** For example for Message box button captions:
"OK", "Cancel", "Yes", "No" and so on. */
virtual void setDefaultText(EGUI_DEFAULT_TEXT which, const wchar_t* newText) = 0;
virtual void setDefaultText(EGUI_DEFAULT_TEXT which, const wchar_t *newText) = 0;
//! sets a default size
virtual void setSize(EGUI_DEFAULT_SIZE which, s32 size) = 0;
//! returns the default font
virtual IGUIFont* getFont(EGUI_DEFAULT_FONT which=EGDF_DEFAULT) const = 0;
virtual IGUIFont *getFont(EGUI_DEFAULT_FONT which = EGDF_DEFAULT) const = 0;
//! sets a default font
virtual void setFont(IGUIFont* font, EGUI_DEFAULT_FONT which=EGDF_DEFAULT) = 0;
virtual void setFont(IGUIFont *font, EGUI_DEFAULT_FONT which = EGDF_DEFAULT) = 0;
//! returns the sprite bank
virtual IGUISpriteBank* getSpriteBank() const = 0;
virtual IGUISpriteBank *getSpriteBank() const = 0;
//! sets the sprite bank
virtual void setSpriteBank(IGUISpriteBank* bank) = 0;
virtual void setSpriteBank(IGUISpriteBank *bank) = 0;
//! Returns a default icon
/** Returns the sprite index within the sprite bank */
@ -438,9 +430,9 @@ namespace gui
implementations to find out how to draw the part exactly.
\param rect: Defining area where to draw.
\param clip: Clip area. */
virtual void draw3DButtonPaneStandard(IGUIElement* element,
const core::rect<s32>& rect,
const core::rect<s32>* clip=0) = 0;
virtual void draw3DButtonPaneStandard(IGUIElement *element,
const core::rect<s32> &rect,
const core::rect<s32> *clip = 0) = 0;
//! draws a pressed 3d button pane
/** Used for drawing for example buttons in pressed state.
@ -451,9 +443,9 @@ namespace gui
implementations to find out how to draw the part exactly.
\param rect: Defining area where to draw.
\param clip: Clip area. */
virtual void draw3DButtonPanePressed(IGUIElement* element,
const core::rect<s32>& rect,
const core::rect<s32>* clip=0) = 0;
virtual void draw3DButtonPanePressed(IGUIElement *element,
const core::rect<s32> &rect,
const core::rect<s32> *clip = 0) = 0;
//! draws a sunken 3d pane
/** Used for drawing the background of edit, combo or check boxes.
@ -467,10 +459,10 @@ namespace gui
color or not be drawn at all.
\param rect: Defining area where to draw.
\param clip: Clip area. */
virtual void draw3DSunkenPane(IGUIElement* element,
virtual void draw3DSunkenPane(IGUIElement *element,
video::SColor bgcolor, bool flat, bool fillBackGround,
const core::rect<s32>& rect,
const core::rect<s32>* clip=0) = 0;
const core::rect<s32> &rect,
const core::rect<s32> *clip = 0) = 0;
//! draws a window background
/** Used for drawing the background of dialogs and windows.
@ -486,11 +478,11 @@ namespace gui
That is the area without borders and without titlebar.
\return Returns rect where it would be good to draw title bar text. This will
work even when checkClientArea is set to a non-null value.*/
virtual core::rect<s32> draw3DWindowBackground(IGUIElement* element,
virtual core::rect<s32> draw3DWindowBackground(IGUIElement *element,
bool drawTitleBar, video::SColor titleBarColor,
const core::rect<s32>& rect,
const core::rect<s32>* clip=0,
core::rect<s32>* checkClientArea=0) = 0;
const core::rect<s32> &rect,
const core::rect<s32> *clip = 0,
core::rect<s32> *checkClientArea = 0) = 0;
//! draws a standard 3d menu pane
/** Used for drawing for menus and context menus.
@ -501,9 +493,9 @@ namespace gui
implementations to find out how to draw the part exactly.
\param rect: Defining area where to draw.
\param clip: Clip area. */
virtual void draw3DMenuPane(IGUIElement* element,
const core::rect<s32>& rect,
const core::rect<s32>* clip=0) = 0;
virtual void draw3DMenuPane(IGUIElement *element,
const core::rect<s32> &rect,
const core::rect<s32> *clip = 0) = 0;
//! draws a standard 3d tool bar
/** Used for drawing for toolbars and menus.
@ -512,9 +504,9 @@ namespace gui
implementations to find out how to draw the part exactly.
\param rect: Defining area where to draw.
\param clip: Clip area. */
virtual void draw3DToolBar(IGUIElement* element,
const core::rect<s32>& rect,
const core::rect<s32>* clip=0) = 0;
virtual void draw3DToolBar(IGUIElement *element,
const core::rect<s32> &rect,
const core::rect<s32> *clip = 0) = 0;
//! draws a tab button
/** Used for drawing for tab buttons on top of tabs.
@ -525,8 +517,8 @@ namespace gui
\param rect: Defining area where to draw.
\param clip: Clip area.
\param alignment Alignment of GUI element. */
virtual void draw3DTabButton(IGUIElement* element, bool active,
const core::rect<s32>& rect, const core::rect<s32>* clip=0, gui::EGUI_ALIGNMENT alignment=EGUIA_UPPERLEFT) = 0;
virtual void draw3DTabButton(IGUIElement *element, bool active,
const core::rect<s32> &rect, const core::rect<s32> *clip = 0, gui::EGUI_ALIGNMENT alignment = EGUIA_UPPERLEFT) = 0;
//! draws a tab control body
/** \param element: Pointer to the element which wishes to draw this. This parameter
@ -538,8 +530,8 @@ namespace gui
\param clip: Clip area.
\param tabHeight Height of tab.
\param alignment Alignment of GUI element. */
virtual void draw3DTabBody(IGUIElement* element, bool border, bool background,
const core::rect<s32>& rect, const core::rect<s32>* clip=0, s32 tabHeight=-1, gui::EGUI_ALIGNMENT alignment=EGUIA_UPPERLEFT ) = 0;
virtual void draw3DTabBody(IGUIElement *element, bool border, bool background,
const core::rect<s32> &rect, const core::rect<s32> *clip = 0, s32 tabHeight = -1, gui::EGUI_ALIGNMENT alignment = EGUIA_UPPERLEFT) = 0;
//! draws an icon, usually from the skin's sprite bank
/** \param element: Pointer to the element which wishes to draw this icon.
@ -551,9 +543,9 @@ namespace gui
\param currenttime: The present time, used to calculate the frame number
\param loop: Whether the animation should loop or not
\param clip: Clip area. */
virtual void drawIcon(IGUIElement* element, EGUI_DEFAULT_ICON icon,
const core::position2di position, u32 starttime=0, u32 currenttime=0,
bool loop=false, const core::rect<s32>* clip=0) = 0;
virtual void drawIcon(IGUIElement *element, EGUI_DEFAULT_ICON icon,
const core::position2di position, u32 starttime = 0, u32 currenttime = 0,
bool loop = false, const core::rect<s32> *clip = 0) = 0;
//! draws a 2d rectangle.
/** \param element: Pointer to the element which wishes to draw this icon.
@ -564,13 +556,12 @@ namespace gui
\param pos: Position of the rectangle.
\param clip: Pointer to rectangle against which the rectangle will be clipped.
If the pointer is null, no clipping will be performed. */
virtual void draw2DRectangle(IGUIElement* element, const video::SColor &color,
const core::rect<s32>& pos, const core::rect<s32>* clip = 0) = 0;
virtual void draw2DRectangle(IGUIElement *element, const video::SColor &color,
const core::rect<s32> &pos, const core::rect<s32> *clip = 0) = 0;
//! get the type of this skin
virtual EGUI_SKIN_TYPE getType() const { return EGST_UNKNOWN; }
};
};
} // end namespace gui
} // end namespace irr

62
include/IGUISpriteBank.h
View File

@ -14,7 +14,7 @@ namespace irr
namespace video
{
class ITexture;
class ITexture;
} // end namespace video
namespace gui
@ -24,12 +24,13 @@ namespace gui
// Note for implementer: Can't fix variable names to uppercase as this is a public interface used since a while
struct SGUISpriteFrame
{
SGUISpriteFrame() : textureNumber(0), rectNumber(0)
SGUISpriteFrame() :
textureNumber(0), rectNumber(0)
{
}
SGUISpriteFrame(u32 textureIndex, u32 positionIndex)
: textureNumber(textureIndex), rectNumber(positionIndex)
SGUISpriteFrame(u32 textureIndex, u32 positionIndex) :
textureNumber(textureIndex), rectNumber(positionIndex)
{
}
@ -44,8 +45,10 @@ struct SGUISpriteFrame
// Note for implementer: Can't fix variable names to uppercase as this is a public interface used since a while
struct SGUISprite
{
SGUISprite() : frameTime(0) {}
SGUISprite(const SGUISpriteFrame& firstFrame) : frameTime(0)
SGUISprite() :
frameTime(0) {}
SGUISprite(const SGUISpriteFrame &firstFrame) :
frameTime(0)
{
Frames.push_back(firstFrame);
}
@ -54,37 +57,35 @@ struct SGUISprite
u32 frameTime;
};
//! Sprite bank interface.
/** See http://http://irrlicht.sourceforge.net/forum//viewtopic.php?f=9&t=25742
* for more information how to use the spritebank.
*/
* for more information how to use the spritebank.
*/
class IGUISpriteBank : public virtual IReferenceCounted
{
public:
//! Returns the list of rectangles held by the sprite bank
virtual core::array< core::rect<s32> >& getPositions() = 0;
virtual core::array<core::rect<s32>> &getPositions() = 0;
//! Returns the array of animated sprites within the sprite bank
virtual core::array< SGUISprite >& getSprites() = 0;
virtual core::array<SGUISprite> &getSprites() = 0;
//! Returns the number of textures held by the sprite bank
virtual u32 getTextureCount() const = 0;
//! Gets the texture with the specified index
virtual video::ITexture* getTexture(u32 index) const = 0;
virtual video::ITexture *getTexture(u32 index) const = 0;
//! Adds a texture to the sprite bank
virtual void addTexture(video::ITexture* texture) = 0;
virtual void addTexture(video::ITexture *texture) = 0;
//! Changes one of the textures in the sprite bank
virtual void setTexture(u32 index, video::ITexture* texture) = 0;
virtual void setTexture(u32 index, video::ITexture *texture) = 0;
//! Add the texture and use it for a single non-animated sprite.
/** The texture and the corresponding rectangle and sprite will all be added to the end of each array.
\returns The index of the sprite or -1 on failure */
virtual s32 addTextureAsSprite(video::ITexture* texture) = 0;
virtual s32 addTextureAsSprite(video::ITexture *texture) = 0;
//! Clears sprites, rectangles and textures
virtual void clear() = 0;
@ -102,11 +103,11 @@ public:
\param loop When true animations are looped
\param center When true pivot is set to the sprite-center. So it affects pos.
*/
virtual void draw2DSprite(u32 index, const core::position2di& pos,
const core::rect<s32>* clip=0,
const video::SColor& color= video::SColor(255,255,255,255),
u32 starttime=0, u32 currenttime=0,
bool loop=true, bool center=false) = 0;
virtual void draw2DSprite(u32 index, const core::position2di &pos,
const core::rect<s32> *clip = 0,
const video::SColor &color = video::SColor(255, 255, 255, 255),
u32 starttime = 0, u32 currenttime = 0,
bool loop = true, bool center = false) = 0;
//! Draws a sprite in 2d with destination rectangle and colors
/**
@ -119,20 +120,19 @@ public:
(same as currenttime-starttime in other draw2DSprite function)
\param loop When true animations are looped
*/
virtual void draw2DSprite(u32 index, const core::rect<s32>& destRect,
const core::rect<s32>* clip=0,
const video::SColor * const colors=0,
virtual void draw2DSprite(u32 index, const core::rect<s32> &destRect,
const core::rect<s32> *clip = 0,
const video::SColor *const colors = 0,
u32 timeTicks = 0,
bool loop=true) = 0;
bool loop = true) = 0;
//! Draws a sprite batch in 2d using an array of positions and a color
virtual void draw2DSpriteBatch(const core::array<u32>& indices, const core::array<core::position2di>& pos,
const core::rect<s32>* clip=0,
const video::SColor& color= video::SColor(255,255,255,255),
u32 starttime=0, u32 currenttime=0,
bool loop=true, bool center=false) = 0;
virtual void draw2DSpriteBatch(const core::array<u32> &indices, const core::array<core::position2di> &pos,
const core::rect<s32> *clip = 0,
const video::SColor &color = video::SColor(255, 255, 255, 255),
u32 starttime = 0, u32 currenttime = 0,
bool loop = true, bool center = false) = 0;
};
} // end namespace gui
} // end namespace irr

24
include/IGUIStaticText.h
View File

@ -11,30 +11,29 @@ namespace irr
{
namespace gui
{
class IGUIFont;
//! Multi or single line text label.
class IGUIStaticText : public IGUIElement
{
public:
class IGUIFont;
//! Multi or single line text label.
class IGUIStaticText : public IGUIElement
{
public:
//! constructor
IGUIStaticText(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
: IGUIElement(EGUIET_STATIC_TEXT, environment, parent, id, rectangle) {}
IGUIStaticText(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect<s32> rectangle) :
IGUIElement(EGUIET_STATIC_TEXT, environment, parent, id, rectangle) {}
//! Sets another skin independent font.
/** If this is set to zero, the button uses the font of the skin.
\param font: New font to set. */
virtual void setOverrideFont(IGUIFont* font=0) = 0;
virtual void setOverrideFont(IGUIFont *font = 0) = 0;
//! Gets the override font (if any)
/** \return The override font (may be 0) */
virtual IGUIFont* getOverrideFont(void) const = 0;
virtual IGUIFont *getOverrideFont(void) const = 0;
//! Get the font which is used right now for drawing
/** Currently this is the override font when one is set and the
font of the active skin otherwise */
virtual IGUIFont* getActiveFont() const = 0;
virtual IGUIFont *getActiveFont() const = 0;
//! Sets another color for the text.
/** If set, the static text does not use the EGDC_BUTTON_TEXT color defined
@ -128,8 +127,7 @@ namespace gui
//! Checks whether the text in this element should be interpreted as right-to-left
virtual bool isRightToLeft() const = 0;
};
};
} // end namespace gui
} // end namespace irr

60
include/IGUITabControl.h
View File

@ -12,31 +12,30 @@ namespace irr
{
namespace gui
{
class IGUITab;
//! A standard tab control
/** \par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_TAB_CHANGED
*/
class IGUITabControl : public IGUIElement
{
public:
class IGUITab;
//! A standard tab control
/** \par This element can create the following events of type EGUI_EVENT_TYPE:
\li EGET_TAB_CHANGED
*/
class IGUITabControl : public IGUIElement
{
public:
//! constructor
IGUITabControl(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
: IGUIElement(EGUIET_TAB_CONTROL, environment, parent, id, rectangle) {}
IGUITabControl(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect<s32> rectangle) :
IGUIElement(EGUIET_TAB_CONTROL, environment, parent, id, rectangle) {}
//! Adds a tab
virtual IGUITab* addTab(const wchar_t* caption, s32 id=-1) = 0;
virtual IGUITab *addTab(const wchar_t *caption, s32 id = -1) = 0;
//! Adds an existing tab
/** Note that it will also add the tab as a child of this TabControl.
\return Index of added tab or -1 for failure*/
virtual s32 addTab(IGUITab* tab) = 0;
virtual s32 addTab(IGUITab *tab) = 0;
//! Insert the tab at the given index
/** \return The tab on success or NULL on failure. */
virtual IGUITab* insertTab(s32 idx, const wchar_t* caption, s32 id=-1) = 0;
virtual IGUITab *insertTab(s32 idx, const wchar_t *caption, s32 id = -1) = 0;
//! Insert an existing tab
/** Note that it will also add the tab as a child of this TabControl.
@ -48,7 +47,7 @@ namespace gui
When true it reserves space for the index, doesn't move but replaces tabs
and it doesn't change the active tab.
\return Index of added tab (should be same as the one passed) or -1 for failure*/
virtual s32 insertTab(s32 idx, IGUITab* tab, bool serializationMode=false) = 0;
virtual s32 insertTab(s32 idx, IGUITab *tab, bool serializationMode = false) = 0;
//! Removes a tab from the tabcontrol
virtual void removeTab(s32 idx) = 0;
@ -63,7 +62,7 @@ namespace gui
/** \param idx: zero based index of tab. Is a value between 0 and getTabcount()-1;
\return Returns pointer to the Tab. Returns 0 if no tab
is corresponding to this tab. */
virtual IGUITab* getTab(s32 idx) const = 0;
virtual IGUITab *getTab(s32 idx) const = 0;
//! For given element find if it's a tab and return it's zero-based index (or -1 for not found)
/** \param tab Tab for which we are looking (usually you will look for an IGUITab* type as only
@ -90,46 +89,45 @@ namespace gui
virtual s32 getTabAt(s32 xpos, s32 ypos) const = 0;
//! Set the height of the tabs
virtual void setTabHeight( s32 height ) = 0;
virtual void setTabHeight(s32 height) = 0;
//! Get the height of the tabs
/** return Returns the height of the tabs */
virtual s32 getTabHeight() const = 0;
//! set the maximal width of a tab. Per default width is 0 which means "no width restriction".
virtual void setTabMaxWidth(s32 width ) = 0;
virtual void setTabMaxWidth(s32 width) = 0;
//! get the maximal width of a tab
virtual s32 getTabMaxWidth() const = 0;
//! Set the alignment of the tabs
/** Use EGUIA_UPPERLEFT or EGUIA_LOWERRIGHT */
virtual void setTabVerticalAlignment( gui::EGUI_ALIGNMENT alignment ) = 0;
virtual void setTabVerticalAlignment(gui::EGUI_ALIGNMENT alignment) = 0;
//! Get the alignment of the tabs
/** return Returns the alignment of the tabs */
virtual gui::EGUI_ALIGNMENT getTabVerticalAlignment() const = 0;
//! Set the extra width added to tabs on each side of the text
virtual void setTabExtraWidth( s32 extraWidth ) = 0;
virtual void setTabExtraWidth(s32 extraWidth) = 0;
//! Get the extra width added to tabs on each side of the text
/** return Returns the extra width of the tabs */
virtual s32 getTabExtraWidth() const = 0;
};
//! A tab-page, onto which other gui elements could be added.
/** IGUITab refers mostly to the page itself, but also carries some data about the tab in the tabbar of an IGUITabControl. */
class IGUITab : public IGUIElement
{
public:
};
//! A tab-page, onto which other gui elements could be added.
/** IGUITab refers mostly to the page itself, but also carries some data about the tab in the tabbar of an IGUITabControl. */
class IGUITab : public IGUIElement
{
public:
//! constructor
IGUITab(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
: IGUIElement(EGUIET_TAB, environment, parent, id, rectangle) {}
IGUITab(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect<s32> rectangle) :
IGUIElement(EGUIET_TAB, environment, parent, id, rectangle) {}
//! sets if the tab should draw its background
virtual void setDrawBackground(bool draw=true) = 0;
virtual void setDrawBackground(bool draw = true) = 0;
//! sets the color of the background, if it should be drawn.
virtual void setBackgroundColor(video::SColor c) = 0;
@ -145,7 +143,7 @@ namespace gui
//! gets the color of the text
virtual video::SColor getTextColor() const = 0;
};
};
} // end namespace gui
} // end namespace irr

26
include/IGUIToolbar.h
View File

@ -10,27 +10,25 @@ namespace irr
{
namespace video
{
class ITexture;
class ITexture;
} // end namespace video
namespace gui
{
class IGUIButton;
//! Stays at the top of its parent like the menu bar and contains tool buttons
class IGUIToolBar : public IGUIElement
{
public:
class IGUIButton;
//! Stays at the top of its parent like the menu bar and contains tool buttons
class IGUIToolBar : public IGUIElement
{
public:
//! constructor
IGUIToolBar(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
: IGUIElement(EGUIET_TOOL_BAR, environment, parent, id, rectangle) {}
IGUIToolBar(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect<s32> rectangle) :
IGUIElement(EGUIET_TOOL_BAR, environment, parent, id, rectangle) {}
//! Adds a button to the tool bar
virtual IGUIButton* addButton(s32 id=-1, const wchar_t* text=0,const wchar_t* tooltiptext=0,
video::ITexture* img=0, video::ITexture* pressedimg=0,
bool isPushButton=false, bool useAlphaChannel=false) = 0;
};
virtual IGUIButton *addButton(s32 id = -1, const wchar_t *text = 0, const wchar_t *tooltiptext = 0,
video::ITexture *img = 0, video::ITexture *pressedimg = 0,
bool isPushButton = false, bool useAlphaChannel = false) = 0;
};
} // end namespace gui
} // end namespace irr

113
include/IImage.h
View File

@ -23,9 +23,8 @@ NOTE: Floating point formats are not well supported yet. Basically only getData(
class IImage : public virtual IReferenceCounted
{
public:
//! constructor
IImage(ECOLOR_FORMAT format, const core::dimension2d<u32>& size, bool deleteMemory) :
IImage(ECOLOR_FORMAT format, const core::dimension2d<u32> &size, bool deleteMemory) :
Format(format), Size(size), Data(0), MipMapsData(0), BytesPerPixel(0), Pitch(0), DeleteMemory(deleteMemory), DeleteMipMapsMemory(false)
{
BytesPerPixel = getBitsPerPixelFromFormat(Format) / 8;
@ -49,7 +48,7 @@ public:
}
//! Returns width and height of image data.
const core::dimension2d<u32>& getDimension() const
const core::dimension2d<u32> &getDimension() const
{
return Size;
}
@ -88,8 +87,7 @@ public:
//! Returns mask for red value of a pixel
u32 getRedMask() const
{
switch (Format)
{
switch (Format) {
case ECF_A1R5G5B5:
return 0x1F << 10;
case ECF_R5G6B5:
@ -106,8 +104,7 @@ public:
//! Returns mask for green value of a pixel
u32 getGreenMask() const
{
switch (Format)
{
switch (Format) {
case ECF_A1R5G5B5:
return 0x1F << 5;
case ECF_R5G6B5:
@ -124,8 +121,7 @@ public:
//! Returns mask for blue value of a pixel
u32 getBlueMask() const
{
switch (Format)
{
switch (Format) {
case ECF_A1R5G5B5:
return 0x1F;
case ECF_R5G6B5:
@ -142,8 +138,7 @@ public:
//! Returns mask for alpha value of a pixel
u32 getAlphaMask() const
{
switch (Format)
{
switch (Format) {
case ECF_A1R5G5B5:
return 0x1 << 15;
case ECF_R5G6B5:
@ -162,7 +157,7 @@ public:
\return Pointer to the image data. What type of data is pointed to
depends on the color format of the image. For example if the color
format is ECF_A8R8G8B8, it is of u32. */
void* getData() const
void *getData() const
{
return Data;
}
@ -175,43 +170,38 @@ public:
return getMipMapsSize(Size, mipmapLevel);
}
//! Calculate mipmap size for a certain level
/** level 0 will be full image size. Every further level is half the size. */
static core::dimension2du getMipMapsSize(const core::dimension2du& sizeLevel0, u32 mipmapLevel)
static core::dimension2du getMipMapsSize(const core::dimension2du &sizeLevel0, u32 mipmapLevel)
{
core::dimension2du result(sizeLevel0);
u32 i=0;
while (i != mipmapLevel)
{
if (result.Width>1)
u32 i = 0;
while (i != mipmapLevel) {
if (result.Width > 1)
result.Width >>= 1;
if (result.Height>1)
result.Height>>=1;
if (result.Height > 1)
result.Height >>= 1;
++i;
if ( result.Width == 1 && result.Height == 1 && i < mipmapLevel )
return core::dimension2du(0,0);
if (result.Width == 1 && result.Height == 1 && i < mipmapLevel)
return core::dimension2du(0, 0);
}
return result;
}
//! Get mipmaps data.
/** Note that different mip levels are just behind each other in memory block.
So if you just get level 1 you also have the data for all other levels.
There is no level 0 - use getData to get the original image data.
*/
void* getMipMapsData(irr::u32 mipLevel=1) const
{
if ( MipMapsData && mipLevel > 0)
void *getMipMapsData(irr::u32 mipLevel = 1) const
{
if (MipMapsData && mipLevel > 0) {
size_t dataSize = 0;
core::dimension2du mipSize(Size);
u32 i = 1; // We want the start of data for this level, not end.
while (i != mipLevel)
{
while (i != mipLevel) {
if (mipSize.Width > 1)
mipSize.Width >>= 1;
@ -221,7 +211,7 @@ public:
dataSize += getDataSizeFromFormat(Format, mipSize.Width, mipSize.Height);
++i;
if ( mipSize.Width == 1 && mipSize.Height == 1 && i < mipLevel)
if (mipSize.Width == 1 && mipSize.Height == 1 && i < mipLevel)
return 0;
}
@ -240,33 +230,26 @@ public:
will by copied internally.
\param deleteMemory Whether the memory is deallocated upon
destruction. */
void setMipMapsData(void* data, bool ownForeignMemory)
{
if (data != MipMapsData)
{
if (DeleteMipMapsMemory)
void setMipMapsData(void *data, bool ownForeignMemory)
{
if (data != MipMapsData) {
if (DeleteMipMapsMemory) {
delete[] MipMapsData;
DeleteMipMapsMemory = false;
}
if (data)
{
if (ownForeignMemory)
{
MipMapsData = static_cast<u8*>(data);
if (data) {
if (ownForeignMemory) {
MipMapsData = static_cast<u8 *>(data);
DeleteMipMapsMemory = false;
}
else
{
} else {
u32 dataSize = 0;
u32 width = Size.Width;
u32 height = Size.Height;
do
{
do {
if (width > 1)
width >>= 1;
@ -281,9 +264,7 @@ public:
DeleteMipMapsMemory = true;
}
}
else
{
} else {
MipMapsData = 0;
}
}
@ -293,51 +274,50 @@ public:
virtual SColor getPixel(u32 x, u32 y) const = 0;
//! Sets a pixel
virtual void setPixel(u32 x, u32 y, const SColor &color, bool blend = false ) = 0;
virtual void setPixel(u32 x, u32 y, const SColor &color, bool blend = false) = 0;
//! Copies this surface into another, if it has the exact same size and format.
/** NOTE: mipmaps are ignored
\return True if it was copied, false otherwise.
*/
virtual bool copyToNoScaling(void *target, u32 width, u32 height, ECOLOR_FORMAT format=ECF_A8R8G8B8, u32 pitch=0) const = 0;
virtual bool copyToNoScaling(void *target, u32 width, u32 height, ECOLOR_FORMAT format = ECF_A8R8G8B8, u32 pitch = 0) const = 0;
//! Copies the image into the target, scaling the image to fit
/** NOTE: mipmaps are ignored */
virtual void copyToScaling(void* target, u32 width, u32 height, ECOLOR_FORMAT format=ECF_A8R8G8B8, u32 pitch=0) =0;
virtual void copyToScaling(void *target, u32 width, u32 height, ECOLOR_FORMAT format = ECF_A8R8G8B8, u32 pitch = 0) = 0;
//! Copies the image into the target, scaling the image to fit
/** NOTE: mipmaps are ignored */
virtual void copyToScaling(IImage* target) =0;
virtual void copyToScaling(IImage *target) = 0;
//! copies this surface into another
/** NOTE: mipmaps are ignored */
virtual void copyTo(IImage* target, const core::position2d<s32>& pos=core::position2d<s32>(0,0)) =0;
virtual void copyTo(IImage *target, const core::position2d<s32> &pos = core::position2d<s32>(0, 0)) = 0;
//! copies this surface into another
/** NOTE: mipmaps are ignored */
virtual void copyTo(IImage* target, const core::position2d<s32>& pos, const core::rect<s32>& sourceRect, const core::rect<s32>* clipRect=0) =0;
virtual void copyTo(IImage *target, const core::position2d<s32> &pos, const core::rect<s32> &sourceRect, const core::rect<s32> *clipRect = 0) = 0;
//! copies this surface into another, using the alpha mask and cliprect and a color to add with
/** NOTE: mipmaps are ignored
\param combineAlpha - When true then combine alpha channels. When false replace target image alpha with source image alpha.
*/
virtual void copyToWithAlpha(IImage* target, const core::position2d<s32>& pos,
const core::rect<s32>& sourceRect, const SColor &color,
const core::rect<s32>* clipRect = 0,
bool combineAlpha=false) =0;
virtual void copyToWithAlpha(IImage *target, const core::position2d<s32> &pos,
const core::rect<s32> &sourceRect, const SColor &color,
const core::rect<s32> *clipRect = 0,
bool combineAlpha = false) = 0;
//! copies this surface into another, scaling it to fit, applying a box filter
/** NOTE: mipmaps are ignored */
virtual void copyToScalingBoxFilter(IImage* target, s32 bias = 0, bool blend = false) = 0;
virtual void copyToScalingBoxFilter(IImage *target, s32 bias = 0, bool blend = false) = 0;
//! fills the surface with given color
virtual void fill(const SColor &color) =0;
virtual void fill(const SColor &color) = 0;
//! get the amount of Bits per Pixel of the given color format
static u32 getBitsPerPixelFromFormat(const ECOLOR_FORMAT format)
{
switch(format)
{
switch (format) {
case ECF_A1R5G5B5:
return 16;
case ECF_R5G6B5:
@ -396,8 +376,7 @@ public:
//! check if the color format is only viable for depth/stencil textures
static bool isDepthFormat(const ECOLOR_FORMAT format)
{
switch(format)
{
switch (format) {
case ECF_D16:
case ECF_D32:
case ECF_D24S8:
@ -413,8 +392,7 @@ public:
if (isCompressedFormat(format))
return false;
switch(format)
{
switch (format) {
case ECF_R16F:
case ECF_G16R16F:
case ECF_A16B16G16R16F:
@ -432,8 +410,8 @@ protected:
ECOLOR_FORMAT Format;
core::dimension2d<u32> Size;
u8* Data;
u8* MipMapsData;
u8 *Data;
u8 *MipMapsData;
u32 BytesPerPixel;
u32 Pitch;
@ -442,6 +420,5 @@ protected:
bool DeleteMipMapsMemory;
};
} // end namespace video
} // end namespace irr

10
include/IImageLoader.h
View File

@ -14,7 +14,7 @@ namespace irr
{
namespace io
{
class IReadFile;
class IReadFile;
} // end namespace io
namespace video
{
@ -27,25 +27,23 @@ IVideoDriver::addExternalImageLoader() to the engine. */
class IImageLoader : public virtual IReferenceCounted
{
public:
//! Check if the file might be loaded by this class
/** Check is based on the file extension (e.g. ".tga")
\param filename Name of file to check.
\return True if file seems to be loadable. */
virtual bool isALoadableFileExtension(const io::path& filename) const = 0;
virtual bool isALoadableFileExtension(const io::path &filename) const = 0;
//! Check if the file might be loaded by this class
/** Check might look into the file.
\param file File handle to check.
\return True if file seems to be loadable. */
virtual bool isALoadableFileFormat(io::IReadFile* file) const = 0;
virtual bool isALoadableFileFormat(io::IReadFile *file) const = 0;
//! Creates a surface from the file
/** \param file File handle to check.
\return Pointer to newly created image, or 0 upon error. */
virtual IImage* loadImage(io::IReadFile* file) const = 0;
virtual IImage *loadImage(io::IReadFile *file) const = 0;
};
} // end namespace video
} // end namespace irr

7
include/IImageWriter.h
View File

@ -12,13 +12,12 @@ namespace irr
{
namespace io
{
class IWriteFile;
class IWriteFile;
} // end namespace io
namespace video
{
class IImage;
class IImage;
//! Interface for writing software image data.
class IImageWriter : public IReferenceCounted
@ -27,7 +26,7 @@ public:
//! Check if this writer can write a file with the given extension
/** \param filename Name of the file to check.
\return True if file extension specifies a writable type. */
virtual bool isAWriteableFileExtension(const io::path& filename) const = 0;
virtual bool isAWriteableFileExtension(const io::path &filename) const = 0;
//! Write image to file
/** \param file File handle to write to.

40
include/IIndexBuffer.h
View File

@ -20,33 +20,32 @@ namespace video
namespace scene
{
class IIndexBuffer : public virtual IReferenceCounted
{
public:
class IIndexBuffer : public virtual IReferenceCounted
{
public:
virtual void *getData() = 0;
virtual void* getData() =0;
virtual video::E_INDEX_TYPE getType() const = 0;
virtual void setType(video::E_INDEX_TYPE IndexType) = 0;
virtual video::E_INDEX_TYPE getType() const =0;
virtual void setType(video::E_INDEX_TYPE IndexType) =0;
virtual u32 stride() const = 0;
virtual u32 stride() const =0;
virtual u32 size() const = 0;
virtual void push_back(const u32 &element) = 0;
virtual u32 operator[](u32 index) const = 0;
virtual u32 getLast() = 0;
virtual void setValue(u32 index, u32 value) = 0;
virtual void set_used(u32 usedNow) = 0;
virtual void reallocate(u32 new_size) = 0;
virtual u32 allocated_size() const = 0;
virtual u32 size() const =0;
virtual void push_back (const u32 &element) =0;
virtual u32 operator [](u32 index) const =0;
virtual u32 getLast() =0;
virtual void setValue(u32 index, u32 value) =0;
virtual void set_used(u32 usedNow) =0;
virtual void reallocate(u32 new_size) =0;
virtual u32 allocated_size() const=0;
virtual void* pointer() =0;
virtual void *pointer() = 0;
//! get the current hardware mapping hint
virtual E_HARDWARE_MAPPING getHardwareMappingHint() const =0;
virtual E_HARDWARE_MAPPING getHardwareMappingHint() const = 0;
//! set the hardware mapping hint, for driver
virtual void setHardwareMappingHint( E_HARDWARE_MAPPING NewMappingHint ) =0;
virtual void setHardwareMappingHint(E_HARDWARE_MAPPING NewMappingHint) = 0;
//! flags the meshbuffer as changed, reloads hardware buffers
virtual void setDirty() = 0;
@ -54,8 +53,7 @@ namespace scene
//! Get the currently used ID for identification of changes.
/** This shouldn't be used for anything outside the VideoDriver. */
virtual u32 getChangedID() const = 0;
};
};
} // end namespace scene
} // end namespace irr

6
include/ILogger.h
View File

@ -32,12 +32,10 @@ enum ELOG_LEVEL
ELL_NONE
};
//! Interface for logging messages, warnings and errors
class ILogger : public virtual IReferenceCounted
{
public:
//! Destructor
virtual ~ILogger() {}
@ -60,7 +58,7 @@ public:
is just an informational text, set it to ELL_INFORMATION. Texts are
filtered with these levels. If you want to be a text displayed,
independent on what level filter is set, use ELL_NONE. */
virtual void log(const c8* text, ELOG_LEVEL ll=ELL_INFORMATION) = 0;
virtual void log(const c8 *text, ELOG_LEVEL ll = ELL_INFORMATION) = 0;
//! Prints out a text into the log
/** \param text: Text to print out.
@ -71,7 +69,7 @@ public:
is just an informational text, set it to ELL_INFORMATION. Texts are
filtered with these levels. If you want to be a text displayed,
independent on what level filter is set, use ELL_NONE. */
virtual void log(const c8* text, const c8* hint, ELOG_LEVEL ll=ELL_INFORMATION) = 0;
virtual void log(const c8 *text, const c8 *hint, ELOG_LEVEL ll = ELL_INFORMATION) = 0;
};
} // end namespace

10
include/IMaterialRenderer.h
View File

@ -24,7 +24,6 @@ engine with new materials. */
class IMaterialRenderer : public virtual IReferenceCounted
{
public:
//! Called by the IVideoDriver implementation the let the renderer set its needed render states.
/** This is called during the IVideoDriver::setMaterial() call.
When overriding this, you can set some renderstates or for example a
@ -47,8 +46,8 @@ public:
fogenable.
\param services: Interface providing some methods for changing
advanced, internal states of a IVideoDriver. */
virtual void OnSetMaterial(const SMaterial& material, const SMaterial& lastMaterial,
bool resetAllRenderstates, IMaterialRendererServices* services) {}
virtual void OnSetMaterial(const SMaterial &material, const SMaterial &lastMaterial,
bool resetAllRenderstates, IMaterialRendererServices *services) {}
//! Called every time before a new bunch of geometry is being drawn using this material with for example drawIndexedTriangleList() call.
/** OnSetMaterial should normally only be called if the renderer decides
@ -68,7 +67,7 @@ public:
example if he doesn't support the specified vertex type. This is
actually done in D3D9 when using a normal mapped material with
a vertex type other than EVT_TANGENTS. */
virtual bool OnRender(IMaterialRendererServices* service, E_VERTEX_TYPE vtxtype) { return true; }
virtual bool OnRender(IMaterialRendererServices *service, E_VERTEX_TYPE vtxtype) { return true; }
//! Called by the IVideoDriver to unset this material.
/** Called during the IVideoDriver::setMaterial() call before the new
@ -95,9 +94,8 @@ public:
//! Access the callback provided by the users when creating shader materials
/** \returns Returns either the users provided callback or 0 when no such
callback exists. Non-shader materials will always return 0. */
virtual IShaderConstantSetCallBack* getShaderConstantSetCallBack() const { return 0; }
virtual IShaderConstantSetCallBack *getShaderConstantSetCallBack() const { return 0; }
};
} // end namespace video
} // end namespace irr

24
include/IMaterialRendererServices.h
View File

@ -14,12 +14,10 @@ namespace video
class IVideoDriver;
//! Interface providing some methods for changing advanced, internal states of a IVideoDriver.
class IMaterialRendererServices
{
public:
//! Destructor
virtual ~IMaterialRendererServices() {}
@ -33,12 +31,12 @@ public:
\param lastMaterial The material used until now.
\param resetAllRenderstates Set to true if all renderstates should be
set, regardless of their current state. */
virtual void setBasicRenderStates(const SMaterial& material,
const SMaterial& lastMaterial,
virtual void setBasicRenderStates(const SMaterial &material,
const SMaterial &lastMaterial,
bool resetAllRenderstates) = 0;
//! Return an index constant for the vertex shader based on a uniform variable name.
virtual s32 getVertexShaderConstantID(const c8* name) = 0;
virtual s32 getVertexShaderConstantID(const c8 *name) = 0;
//! Sets a value for a vertex shader uniform variable.
/** \param index Index of the variable (as received from getVertexShaderConstantID)
@ -46,16 +44,16 @@ public:
\param count Amount of floats in array.
\return True if successful.
*/
virtual bool setVertexShaderConstant(s32 index, const f32* floats, int count) = 0;
virtual bool setVertexShaderConstant(s32 index, const f32 *floats, int count) = 0;
//! Int interface for the above.
virtual bool setVertexShaderConstant(s32 index, const s32* ints, int count) = 0;
virtual bool setVertexShaderConstant(s32 index, const s32 *ints, int count) = 0;
//! Uint interface for the above.
virtual bool setVertexShaderConstant(s32 index, const u32* ints, int count) = 0;
virtual bool setVertexShaderConstant(s32 index, const u32 *ints, int count) = 0;
//! Return an index constant for the pixel shader for the given uniform variable name
virtual s32 getPixelShaderConstantID(const c8* name) = 0;
virtual s32 getPixelShaderConstantID(const c8 *name) = 0;
//! Sets a value for the given pixel shader uniform variable
/** This can be used if you used a high level shader language like GLSL
@ -65,17 +63,17 @@ public:
\param floats Pointer to array of floats
\param count Amount of floats in array.
\return True if successful. */
virtual bool setPixelShaderConstant(s32 index, const f32* floats, int count) = 0;
virtual bool setPixelShaderConstant(s32 index, const f32 *floats, int count) = 0;
//! Int interface for the above.
virtual bool setPixelShaderConstant(s32 index, const s32* ints, int count) = 0;
virtual bool setPixelShaderConstant(s32 index, const s32 *ints, int count) = 0;
//! Uint interface for the above.
virtual bool setPixelShaderConstant(s32 index, const u32* ints, int count) = 0;
virtual bool setPixelShaderConstant(s32 index, const u32 *ints, int count) = 0;
//! Get pointer to the IVideoDriver interface
/** \return Pointer to the IVideoDriver interface */
virtual IVideoDriver* getVideoDriver() = 0;
virtual IVideoDriver *getVideoDriver() = 0;
};
} // end namespace video

10
include/IMemoryReadFile.h
View File

@ -11,10 +11,10 @@ namespace irr
namespace io
{
//! Interface providing read access to a memory read file.
class IMemoryReadFile : public IReadFile
{
public:
//! Interface providing read access to a memory read file.
class IMemoryReadFile : public IReadFile
{
public:
//! Get direct access to internal buffer of memory block used as file.
/** It's usually better to use the IReadFile functions to access
the file content. But as that buffer exist over the full life-time
@ -22,6 +22,6 @@ namespace io
data-copy which read() needs.
*/
virtual const void *getBuffer() const = 0;
};
};
} // end namespace io
} // end namespace irr

46
include/IMesh.h
View File

@ -12,11 +12,11 @@ namespace irr
{
namespace scene
{
//! Possible types of meshes.
// Note: Was previously only used in IAnimatedMesh so it still has the "animated" in the name.
// But can now be used for all mesh-types as we need those casts as well.
enum E_ANIMATED_MESH_TYPE
{
//! Possible types of meshes.
// Note: Was previously only used in IAnimatedMesh so it still has the "animated" in the name.
// But can now be used for all mesh-types as we need those casts as well.
enum E_ANIMATED_MESH_TYPE
{
//! Unknown animated mesh type.
EAMT_UNKNOWN = 0,
@ -57,20 +57,18 @@ namespace scene
//! generic non-animated mesh
EAMT_STATIC
};
};
class IMeshBuffer;
class IMeshBuffer;
//! Class which holds the geometry of an object.
/** An IMesh is nothing more than a collection of some mesh buffers
(IMeshBuffer). SMesh is a simple implementation of an IMesh.
A mesh is usually added to an IMeshSceneNode in order to be rendered.
*/
class IMesh : public virtual IReferenceCounted
{
public:
//! Class which holds the geometry of an object.
/** An IMesh is nothing more than a collection of some mesh buffers
(IMeshBuffer). SMesh is a simple implementation of an IMesh.
A mesh is usually added to an IMeshSceneNode in order to be rendered.
*/
class IMesh : public virtual IReferenceCounted
{
public:
//! Get the amount of mesh buffers.
/** \return Amount of mesh buffers (IMeshBuffer) in this mesh. */
virtual u32 getMeshBufferCount() const = 0;
@ -80,34 +78,34 @@ namespace scene
getMeshBufferCount() - 1;
\return Pointer to the mesh buffer or 0 if there is no such
mesh buffer. */
virtual IMeshBuffer* getMeshBuffer(u32 nr) const = 0;
virtual IMeshBuffer *getMeshBuffer(u32 nr) const = 0;
//! Get pointer to a mesh buffer which fits a material
/** \param material: material to search for
\return Pointer to the mesh buffer or 0 if there is no such
mesh buffer. */
virtual IMeshBuffer* getMeshBuffer( const video::SMaterial &material) const = 0;
virtual IMeshBuffer *getMeshBuffer(const video::SMaterial &material) const = 0;
//! Get an axis aligned bounding box of the mesh.
/** \return Bounding box of this mesh. */
virtual const core::aabbox3d<f32>& getBoundingBox() const = 0;
virtual const core::aabbox3d<f32> &getBoundingBox() const = 0;
//! Set user-defined axis aligned bounding box
/** \param box New bounding box to use for the mesh. */
virtual void setBoundingBox( const core::aabbox3df& box) = 0;
virtual void setBoundingBox(const core::aabbox3df &box) = 0;
//! Set the hardware mapping hint
/** This methods allows to define optimization hints for the
hardware. This enables, e.g., the use of hardware buffers on
platforms that support this feature. This can lead to noticeable
performance gains. */
virtual void setHardwareMappingHint(E_HARDWARE_MAPPING newMappingHint, E_BUFFER_TYPE buffer=EBT_VERTEX_AND_INDEX) = 0;
virtual void setHardwareMappingHint(E_HARDWARE_MAPPING newMappingHint, E_BUFFER_TYPE buffer = EBT_VERTEX_AND_INDEX) = 0;
//! Flag the meshbuffer as changed, reloads hardware buffers
/** This method has to be called every time the vertices or
indices have changed. Otherwise, changes won't be updated
on the GPU in the next render cycle. */
virtual void setDirty(E_BUFFER_TYPE buffer=EBT_VERTEX_AND_INDEX) = 0;
virtual void setDirty(E_BUFFER_TYPE buffer = EBT_VERTEX_AND_INDEX) = 0;
//! Returns the type of the meshes.
/** This is useful for making a safe downcast. For example,
@ -119,7 +117,7 @@ namespace scene
{
return EAMT_STATIC;
}
};
};
} // end namespace scene
} // end namespace irr

113
include/IMeshBuffer.h
View File

@ -16,36 +16,35 @@ namespace irr
{
namespace scene
{
//! Struct for holding a mesh with a single material.
/** A part of an IMesh which has the same material on each face of that
group. Logical groups of an IMesh need not be put into separate mesh
buffers, but can be. Separately animated parts of the mesh must be put
into separate mesh buffers.
Some mesh buffer implementations have limitations on the number of
vertices the buffer can hold. In that case, logical grouping can help.
Moreover, the number of vertices should be optimized for the GPU upload,
which often depends on the type of gfx card. Typical figures are
1000-10000 vertices per buffer.
SMeshBuffer is a simple implementation of a MeshBuffer, which supports
up to 65535 vertices.
//! Struct for holding a mesh with a single material.
/** A part of an IMesh which has the same material on each face of that
group. Logical groups of an IMesh need not be put into separate mesh
buffers, but can be. Separately animated parts of the mesh must be put
into separate mesh buffers.
Some mesh buffer implementations have limitations on the number of
vertices the buffer can hold. In that case, logical grouping can help.
Moreover, the number of vertices should be optimized for the GPU upload,
which often depends on the type of gfx card. Typical figures are
1000-10000 vertices per buffer.
SMeshBuffer is a simple implementation of a MeshBuffer, which supports
up to 65535 vertices.
Since meshbuffers are used for drawing, and hence will be exposed
to the driver, chances are high that they are grab()'ed from somewhere.
It's therefore required to dynamically allocate meshbuffers which are
passed to a video driver and only drop the buffer once it's not used in
the current code block anymore.
*/
class IMeshBuffer : public virtual IReferenceCounted
{
public:
Since meshbuffers are used for drawing, and hence will be exposed
to the driver, chances are high that they are grab()'ed from somewhere.
It's therefore required to dynamically allocate meshbuffers which are
passed to a video driver and only drop the buffer once it's not used in
the current code block anymore.
*/
class IMeshBuffer : public virtual IReferenceCounted
{
public:
//! Get the material of this meshbuffer
/** \return Material of this buffer. */
virtual video::SMaterial &getMaterial() = 0;
//! Get the material of this meshbuffer
/** \return Material of this buffer. */
virtual video::SMaterial& getMaterial() = 0;
//! Get the material of this meshbuffer
/** \return Material of this buffer. */
virtual const video::SMaterial& getMaterial() const = 0;
virtual const video::SMaterial &getMaterial() const = 0;
//! Get type of vertex data which is stored in this meshbuffer.
/** \return Vertex type of this buffer. */
@ -54,12 +53,12 @@ namespace scene
//! Get access to vertex data. The data is an array of vertices.
/** Which vertex type is used can be determined by getVertexType().
\return Pointer to array of vertices. */
virtual const void* getVertices() const = 0;
virtual const void *getVertices() const = 0;
//! Get access to vertex data. The data is an array of vertices.
/** Which vertex type is used can be determined by getVertexType().
\return Pointer to array of vertices. */
virtual void* getVertices() = 0;
virtual void *getVertices() = 0;
//! Get amount of vertices in meshbuffer.
/** \return Number of vertices in this buffer. */
@ -67,15 +66,15 @@ namespace scene
//! Get type of index data which is stored in this meshbuffer.
/** \return Index type of this buffer. */
virtual video::E_INDEX_TYPE getIndexType() const =0;
virtual video::E_INDEX_TYPE getIndexType() const = 0;
//! Get access to indices.
/** \return Pointer to indices array. */
virtual const u16* getIndices() const = 0;
virtual const u16 *getIndices() const = 0;
//! Get access to indices.
/** \return Pointer to indices array. */
virtual u16* getIndices() = 0;
virtual u16 *getIndices() = 0;
//! Get amount of indices in this meshbuffer.
/** \return Number of indices in this buffer. */
@ -83,33 +82,33 @@ namespace scene
//! Get the axis aligned bounding box of this meshbuffer.
/** \return Axis aligned bounding box of this buffer. */
virtual const core::aabbox3df& getBoundingBox() const = 0;
virtual const core::aabbox3df &getBoundingBox() const = 0;
//! Set axis aligned bounding box
/** \param box User defined axis aligned bounding box to use
for this buffer. */
virtual void setBoundingBox(const core::aabbox3df& box) = 0;
virtual void setBoundingBox(const core::aabbox3df &box) = 0;
//! Recalculates the bounding box. Should be called if the mesh changed.
virtual void recalculateBoundingBox() = 0;
//! returns position of vertex i
virtual const core::vector3df& getPosition(u32 i) const = 0;
virtual const core::vector3df &getPosition(u32 i) const = 0;
//! returns position of vertex i
virtual core::vector3df& getPosition(u32 i) = 0;
virtual core::vector3df &getPosition(u32 i) = 0;
//! returns normal of vertex i
virtual const core::vector3df& getNormal(u32 i) const = 0;
virtual const core::vector3df &getNormal(u32 i) const = 0;
//! returns normal of vertex i
virtual core::vector3df& getNormal(u32 i) = 0;
virtual core::vector3df &getNormal(u32 i) = 0;
//! returns texture coord of vertex i
virtual const core::vector2df& getTCoords(u32 i) const = 0;
virtual const core::vector2df &getTCoords(u32 i) const = 0;
//! returns texture coord of vertex i
virtual core::vector2df& getTCoords(u32 i) = 0;
virtual core::vector2df &getTCoords(u32 i) = 0;
//! Append the vertices and indices to the current buffer
/** Only works for compatible vertex types.
@ -117,7 +116,7 @@ namespace scene
\param numVertices Number of vertices in the array.
\param indices Pointer to index array.
\param numIndices Number of indices in array. */
virtual void append(const void* const vertices, u32 numVertices, const u16* const indices, u32 numIndices) = 0;
virtual void append(const void *const vertices, u32 numVertices, const u16 *const indices, u32 numIndices) = 0;
//! get the current hardware mapping hint
virtual E_HARDWARE_MAPPING getHardwareMappingHint_Vertex() const = 0;
@ -126,10 +125,10 @@ namespace scene
virtual E_HARDWARE_MAPPING getHardwareMappingHint_Index() const = 0;
//! set the hardware mapping hint, for driver
virtual void setHardwareMappingHint( E_HARDWARE_MAPPING newMappingHint, E_BUFFER_TYPE buffer=EBT_VERTEX_AND_INDEX ) = 0;
virtual void setHardwareMappingHint(E_HARDWARE_MAPPING newMappingHint, E_BUFFER_TYPE buffer = EBT_VERTEX_AND_INDEX) = 0;
//! flags the meshbuffer as changed, reloads hardware buffers
virtual void setDirty(E_BUFFER_TYPE buffer=EBT_VERTEX_AND_INDEX) = 0;
virtual void setDirty(E_BUFFER_TYPE buffer = EBT_VERTEX_AND_INDEX) = 0;
//! Get the currently used ID for identification of changes.
/** This shouldn't be used for anything outside the VideoDriver. */
@ -157,21 +156,27 @@ namespace scene
virtual u32 getPrimitiveCount() const
{
const u32 indexCount = getIndexCount();
switch (getPrimitiveType())
{
case scene::EPT_POINTS: return indexCount;
case scene::EPT_LINE_STRIP: return indexCount-1;
case scene::EPT_LINE_LOOP: return indexCount;
case scene::EPT_LINES: return indexCount/2;
case scene::EPT_TRIANGLE_STRIP: return (indexCount-2);
case scene::EPT_TRIANGLE_FAN: return (indexCount-2);
case scene::EPT_TRIANGLES: return indexCount/3;
case scene::EPT_POINT_SPRITES: return indexCount;
switch (getPrimitiveType()) {
case scene::EPT_POINTS:
return indexCount;
case scene::EPT_LINE_STRIP:
return indexCount - 1;
case scene::EPT_LINE_LOOP:
return indexCount;
case scene::EPT_LINES:
return indexCount / 2;
case scene::EPT_TRIANGLE_STRIP:
return (indexCount - 2);
case scene::EPT_TRIANGLE_FAN:
return (indexCount - 2);
case scene::EPT_TRIANGLES:
return indexCount / 3;
case scene::EPT_POINT_SPRITES:
return indexCount;
}
return 0;
}
};
};
} // end namespace scene
} // end namespace irr

50
include/IMeshCache.h
View File

@ -12,21 +12,20 @@ namespace irr
namespace scene
{
class IMesh;
class IAnimatedMesh;
class IAnimatedMeshSceneNode;
class IMeshLoader;
//! The mesh cache stores already loaded meshes and provides an interface to them.
/** You can access it using ISceneManager::getMeshCache(). All existing
scene managers will return a pointer to the same mesh cache, because it
is shared between them. With this interface, it is possible to manually
add new loaded meshes (if ISceneManager::getMesh() is not sufficient),
to remove them and to iterate through already loaded meshes. */
class IMeshCache : public virtual IReferenceCounted
{
public:
class IMesh;
class IAnimatedMesh;
class IAnimatedMeshSceneNode;
class IMeshLoader;
//! The mesh cache stores already loaded meshes and provides an interface to them.
/** You can access it using ISceneManager::getMeshCache(). All existing
scene managers will return a pointer to the same mesh cache, because it
is shared between them. With this interface, it is possible to manually
add new loaded meshes (if ISceneManager::getMesh() is not sufficient),
to remove them and to iterate through already loaded meshes. */
class IMeshCache : public virtual IReferenceCounted
{
public:
//! Destructor
virtual ~IMeshCache() {}
@ -46,14 +45,14 @@ namespace scene
set by this method.
\param mesh Pointer to a mesh which will now be referenced by
this name. */
virtual void addMesh(const io::path& name, IAnimatedMesh* mesh) = 0;
virtual void addMesh(const io::path &name, IAnimatedMesh *mesh) = 0;
//! Removes the mesh from the cache.
/** After loading a mesh with getMesh(), the mesh can be
removed from the cache using this method, freeing a lot of
memory.
\param mesh Pointer to the mesh which shall be removed. */
virtual void removeMesh(const IMesh* const mesh) = 0;
virtual void removeMesh(const IMesh *const mesh) = 0;
//! Returns amount of loaded meshes in the cache.
/** You can load new meshes into the cache using getMesh() and
@ -66,7 +65,7 @@ namespace scene
//! Returns current index number of the mesh or -1 when not found.
/** \param mesh Pointer to the mesh to search for.
\return Index of the mesh in the cache, or -1 if not found. */
virtual s32 getMeshIndex(const IMesh* const mesh) const = 0;
virtual s32 getMeshIndex(const IMesh *const mesh) const = 0;
//! Returns a mesh based on its index number.
/** \param index: Index of the mesh, number between 0 and
@ -75,22 +74,22 @@ namespace scene
or removed.
\return Pointer to the mesh or 0 if there is none with this
number. */
virtual IAnimatedMesh* getMeshByIndex(u32 index) = 0;
virtual IAnimatedMesh *getMeshByIndex(u32 index) = 0;
//! Returns a mesh based on its name.
/** \param name Name of the mesh. Usually a filename.
\return Pointer to the mesh or 0 if there is none with this number. */
virtual IAnimatedMesh* getMeshByName(const io::path& name) = 0;
virtual IAnimatedMesh *getMeshByName(const io::path &name) = 0;
//! Get the name of a loaded mesh, based on its index.
/** \param index: Index of the mesh, number between 0 and getMeshCount()-1.
\return The name if mesh was found and has a name, else the path is empty. */
virtual const io::SNamedPath& getMeshName(u32 index) const = 0;
virtual const io::SNamedPath &getMeshName(u32 index) const = 0;
//! Get the name of the loaded mesh if there is any.
/** \param mesh Pointer to mesh to query.
\return The name if mesh was found and has a name, else the path is empty. */
virtual const io::SNamedPath& getMeshName(const IMesh* const mesh) const = 0;
virtual const io::SNamedPath &getMeshName(const IMesh *const mesh) const = 0;
//! Renames a loaded mesh.
/** Note that renaming meshes might change the ordering of the
@ -99,7 +98,7 @@ namespace scene
\param index The index of the mesh in the cache.
\param name New name for the mesh.
\return True if mesh was renamed. */
virtual bool renameMesh(u32 index, const io::path& name) = 0;
virtual bool renameMesh(u32 index, const io::path &name) = 0;
//! Renames the loaded mesh
/** Note that renaming meshes might change the ordering of the
@ -108,12 +107,12 @@ namespace scene
\param mesh Mesh to be renamed.
\param name New name for the mesh.
\return True if mesh was renamed. */
virtual bool renameMesh(const IMesh* const mesh, const io::path& name) = 0;
virtual bool renameMesh(const IMesh *const mesh, const io::path &name) = 0;
//! Check if a mesh was already loaded.
/** \param name Name of the mesh. Usually a filename.
\return True if the mesh has been loaded, else false. */
virtual bool isMeshLoaded(const io::path& name) = 0;
virtual bool isMeshLoaded(const io::path &name) = 0;
//! Clears the whole mesh cache, removing all meshes.
/** All meshes will be reloaded completely when using ISceneManager::getMesh()
@ -126,8 +125,7 @@ namespace scene
/** Warning: If you have pointers to meshes that were loaded with ISceneManager::getMesh()
and you did not grab them, then they may become invalid. */
virtual void clearUnusedMeshes() = 0;
};
};
} // end namespace scene
} // end namespace irr

10
include/IMeshLoader.h
View File

@ -11,11 +11,11 @@ namespace irr
{
namespace io
{
class IReadFile;
class IReadFile;
} // end namespace io
namespace scene
{
class IAnimatedMesh;
class IAnimatedMesh;
//! Class which is able to load an animated mesh from a file.
/** If you want Irrlicht be able to load meshes of
@ -25,7 +25,6 @@ ISceneManager::addExternalMeshLoader() to the engine. */
class IMeshLoader : public virtual IReferenceCounted
{
public:
//! Constructor
IMeshLoader() {}
@ -37,16 +36,15 @@ public:
only.
\param filename Name of the file to test.
\return True if the file might be loaded by this class. */
virtual bool isALoadableFileExtension(const io::path& filename) const = 0;
virtual bool isALoadableFileExtension(const io::path &filename) const = 0;
//! Creates/loads an animated mesh from the file.
/** \param file File handler to load the file from.
\return Pointer to the created mesh. Returns 0 if loading failed.
If you no longer need the mesh, you should call IAnimatedMesh::drop().
See IReferenceCounted::drop() for more information. */
virtual IAnimatedMesh* createMesh(io::IReadFile* file) = 0;
virtual IAnimatedMesh *createMesh(io::IReadFile *file) = 0;
};
} // end namespace scene
} // end namespace irr

91
include/IMeshManipulator.h
View File

@ -17,36 +17,35 @@ namespace irr
namespace scene
{
struct SMesh;
//! An interface for easy manipulation of meshes.
/** Scale, set alpha value, flip surfaces, and so on. This exists for
fixing problems with wrong imported or exported meshes quickly after
loading. It is not intended for doing mesh modifications and/or
animations during runtime.
*/
class IMeshManipulator : public virtual IReferenceCounted
{
public:
struct SMesh;
//! An interface for easy manipulation of meshes.
/** Scale, set alpha value, flip surfaces, and so on. This exists for
fixing problems with wrong imported or exported meshes quickly after
loading. It is not intended for doing mesh modifications and/or
animations during runtime.
*/
class IMeshManipulator : public virtual IReferenceCounted
{
public:
//! Recalculates all normals of the mesh.
/** \param mesh: Mesh on which the operation is performed.
\param smooth: If the normals shall be smoothed.
\param angleWeighted: If the normals shall be smoothed in relation to their angles. More expensive, but also higher precision. */
virtual void recalculateNormals(IMesh* mesh, bool smooth = false,
bool angleWeighted = false) const=0;
virtual void recalculateNormals(IMesh *mesh, bool smooth = false,
bool angleWeighted = false) const = 0;
//! Recalculates all normals of the mesh buffer.
/** \param buffer: Mesh buffer on which the operation is performed.
\param smooth: If the normals shall be smoothed.
\param angleWeighted: If the normals shall be smoothed in relation to their angles. More expensive, but also higher precision. */
virtual void recalculateNormals(IMeshBuffer* buffer,
bool smooth = false, bool angleWeighted = false) const=0;
virtual void recalculateNormals(IMeshBuffer *buffer,
bool smooth = false, bool angleWeighted = false) const = 0;
//! Scales the actual mesh, not a scene node.
/** \param mesh Mesh on which the operation is performed.
\param factor Scale factor for each axis. */
void scale(IMesh* mesh, const core::vector3df& factor) const
void scale(IMesh *mesh, const core::vector3df &factor) const
{
apply(SVertexPositionScaleManipulator(factor), mesh, true);
}
@ -54,7 +53,7 @@ namespace scene
//! Scales the actual meshbuffer, not a scene node.
/** \param buffer Meshbuffer on which the operation is performed.
\param factor Scale factor for each axis. */
void scale(IMeshBuffer* buffer, const core::vector3df& factor) const
void scale(IMeshBuffer *buffer, const core::vector3df &factor) const
{
apply(SVertexPositionScaleManipulator(factor), buffer, true);
}
@ -66,17 +65,17 @@ namespace scene
\return Cloned mesh. If you no longer need the
cloned mesh, you should call SMesh::drop(). See
IReferenceCounted::drop() for more information. */
virtual SMesh* createMeshCopy(IMesh* mesh) const = 0;
virtual SMesh *createMeshCopy(IMesh *mesh) const = 0;
//! Get amount of polygons in mesh.
/** \param mesh Input mesh
\return Number of polygons in mesh. */
virtual s32 getPolyCount(IMesh* mesh) const = 0;
virtual s32 getPolyCount(IMesh *mesh) const = 0;
//! Get amount of polygons in mesh.
/** \param mesh Input mesh
\return Number of polygons in mesh. */
virtual s32 getPolyCount(IAnimatedMesh* mesh) const = 0;
virtual s32 getPolyCount(IAnimatedMesh *mesh) const = 0;
//! Create a new AnimatedMesh and adds the mesh to it
/** \param mesh Input mesh
@ -85,7 +84,7 @@ namespace scene
content. When you don't need the animated mesh anymore, you
should call IAnimatedMesh::drop(). See
IReferenceCounted::drop() for more information. */
virtual IAnimatedMesh * createAnimatedMesh(IMesh* mesh,
virtual IAnimatedMesh *createAnimatedMesh(IMesh *mesh,
scene::E_ANIMATED_MESH_TYPE type = scene::EAMT_UNKNOWN) const = 0;
//! Apply a manipulator on the Meshbuffer
@ -94,30 +93,27 @@ namespace scene
\param boundingBoxUpdate Specifies if the bounding box should be updated during manipulation.
\return True if the functor was successfully applied, else false. */
template <typename Functor>
bool apply(const Functor& func, IMeshBuffer* buffer, bool boundingBoxUpdate=false) const
bool apply(const Functor &func, IMeshBuffer *buffer, bool boundingBoxUpdate = false) const
{
return apply_(func, buffer, boundingBoxUpdate, func);
}
//! Apply a manipulator on the Mesh
/** \param func A functor defining the mesh manipulation.
\param mesh The Mesh to apply the manipulator to.
\param boundingBoxUpdate Specifies if the bounding box should be updated during manipulation.
\return True if the functor was successfully applied, else false. */
template <typename Functor>
bool apply(const Functor& func, IMesh* mesh, bool boundingBoxUpdate=false) const
bool apply(const Functor &func, IMesh *mesh, bool boundingBoxUpdate = false) const
{
if (!mesh)
return true;
bool result = true;
core::aabbox3df bufferbox;
for (u32 i=0; i<mesh->getMeshBufferCount(); ++i)
{
for (u32 i = 0; i < mesh->getMeshBufferCount(); ++i) {
result &= apply(func, mesh->getMeshBuffer(i), boundingBoxUpdate);
if (boundingBoxUpdate)
{
if (0==i)
if (boundingBoxUpdate) {
if (0 == i)
bufferbox.reset(mesh->getMeshBuffer(i)->getBoundingBox());
else
bufferbox.addInternalBox(mesh->getMeshBuffer(i)->getBoundingBox());
@ -136,38 +132,29 @@ protected:
\param typeTest Unused parameter, which handles the proper call selection based on the type of the Functor which is passed in two times.
\return True if the functor was successfully applied, else false. */
template <typename Functor>
bool apply_(const Functor& func, IMeshBuffer* buffer, bool boundingBoxUpdate, const IVertexManipulator& typeTest) const
bool apply_(const Functor &func, IMeshBuffer *buffer, bool boundingBoxUpdate, const IVertexManipulator &typeTest) const
{
if (!buffer)
return true;
core::aabbox3df bufferbox;
for (u32 i=0; i<buffer->getVertexCount(); ++i)
{
switch (buffer->getVertexType())
{
case video::EVT_STANDARD:
{
video::S3DVertex* verts = (video::S3DVertex*)buffer->getVertices();
for (u32 i = 0; i < buffer->getVertexCount(); ++i) {
switch (buffer->getVertexType()) {
case video::EVT_STANDARD: {
video::S3DVertex *verts = (video::S3DVertex *)buffer->getVertices();
func(verts[i]);
}
break;
case video::EVT_2TCOORDS:
{
video::S3DVertex2TCoords* verts = (video::S3DVertex2TCoords*)buffer->getVertices();
} break;
case video::EVT_2TCOORDS: {
video::S3DVertex2TCoords *verts = (video::S3DVertex2TCoords *)buffer->getVertices();
func(verts[i]);
}
break;
case video::EVT_TANGENTS:
{
video::S3DVertexTangents* verts = (video::S3DVertexTangents*)buffer->getVertices();
} break;
case video::EVT_TANGENTS: {
video::S3DVertexTangents *verts = (video::S3DVertexTangents *)buffer->getVertices();
func(verts[i]);
} break;
}
break;
}
if (boundingBoxUpdate)
{
if (0==i)
if (boundingBoxUpdate) {
if (0 == i)
bufferbox.reset(buffer->getPosition(0));
else
bufferbox.addInternalPoint(buffer->getPosition(i));

16
include/IMeshSceneNode.h
View File

@ -13,28 +13,26 @@ namespace scene
class IMesh;
//! A scene node displaying a static mesh
class IMeshSceneNode : public ISceneNode
{
public:
//! Constructor
/** Use setMesh() to set the mesh to display.
*/
IMeshSceneNode(ISceneNode* parent, ISceneManager* mgr, s32 id,
const core::vector3df& position = core::vector3df(0,0,0),
const core::vector3df& rotation = core::vector3df(0,0,0),
const core::vector3df& scale = core::vector3df(1,1,1))
: ISceneNode(parent, mgr, id, position, rotation, scale) {}
IMeshSceneNode(ISceneNode *parent, ISceneManager *mgr, s32 id,
const core::vector3df &position = core::vector3df(0, 0, 0),
const core::vector3df &rotation = core::vector3df(0, 0, 0),
const core::vector3df &scale = core::vector3df(1, 1, 1)) :
ISceneNode(parent, mgr, id, position, rotation, scale) {}
//! Sets a new mesh to display
/** \param mesh Mesh to display. */
virtual void setMesh(IMesh* mesh) = 0;
virtual void setMesh(IMesh *mesh) = 0;
//! Get the currently defined mesh for display.
/** \return Pointer to mesh which is displayed by this node. */
virtual IMesh* getMesh(void) = 0;
virtual IMesh *getMesh(void) = 0;
//! Sets if the scene node should not copy the materials of the mesh but use them in a read only style.
/** In this way it is possible to change the materials of a mesh

13
include/IOSOperator.h
View File

@ -15,32 +15,31 @@ class IOSOperator : public virtual IReferenceCounted
{
public:
//! Get the current OS version as string.
virtual const core::stringc& getOperatingSystemVersion() const = 0;
virtual const core::stringc &getOperatingSystemVersion() const = 0;
//! Copies text to the clipboard
//! \param text: text in utf-8
virtual void copyToClipboard(const c8* text) const = 0;
virtual void copyToClipboard(const c8 *text) const = 0;
//! Copies text to the primary selection
//! This is a no-op on some platforms.
//! \param text: text in utf-8
virtual void copyToPrimarySelection(const c8* text) const = 0;
virtual void copyToPrimarySelection(const c8 *text) const = 0;
//! Get text from the clipboard
//! \return Returns 0 if no string is in there, otherwise an utf-8 string.
virtual const c8* getTextFromClipboard() const = 0;
virtual const c8 *getTextFromClipboard() const = 0;
//! Get text from the primary selection
//! This is a no-op on some platforms.
//! \return Returns 0 if no string is in there, otherwise an utf-8 string.
virtual const c8* getTextFromPrimarySelection() const = 0;
virtual const c8 *getTextFromPrimarySelection() const = 0;
//! Get the total and available system RAM
/** \param totalBytes: will contain the total system memory in Kilobytes (1024 B)
\param availableBytes: will contain the available memory in Kilobytes (1024 B)
\return True if successful, false if not */
virtual bool getSystemMemory(u32* totalBytes, u32* availableBytes) const = 0;
virtual bool getSystemMemory(u32 *totalBytes, u32 *availableBytes) const = 0;
};
} // end namespace

18
include/IReadFile.h
View File

@ -13,15 +13,15 @@ namespace irr
namespace io
{
//! Interface providing read access to a file.
class IReadFile : public virtual IReferenceCounted
{
public:
//! Interface providing read access to a file.
class IReadFile : public virtual IReferenceCounted
{
public:
//! Reads an amount of bytes from the file.
/** \param buffer Pointer to buffer where read bytes are written to.
\param sizeToRead Amount of bytes to read from the file.
\return How many bytes were read. */
virtual size_t read(void* buffer, size_t sizeToRead) = 0;
virtual size_t read(void *buffer, size_t sizeToRead) = 0;
//! Changes position in file
/** \param finalPos Destination position in the file.
@ -41,17 +41,17 @@ namespace io
//! Get name of file.
/** \return File name as zero terminated character string. */
virtual const io::path& getFileName() const = 0;
virtual const io::path &getFileName() const = 0;
//! Get the type of the class implementing this interface
virtual EREAD_FILE_TYPE getType() const
{
return EFIT_UNKNOWN;
}
};
};
//! Internal function, please do not use.
IReadFile* createLimitReadFile(const io::path& fileName, IReadFile* alreadyOpenedFile, long pos, long areaSize);
//! Internal function, please do not use.
IReadFile *createLimitReadFile(const io::path &fileName, IReadFile *alreadyOpenedFile, long pos, long areaSize);
} // end namespace io
} // end namespace irr

76
include/IReferenceCounted.h
View File

@ -9,41 +9,40 @@
namespace irr
{
//! Base class of most objects of the Irrlicht Engine.
/** This class provides reference counting through the methods grab() and drop().
It also is able to store a debug string for every instance of an object.
Most objects of the Irrlicht
Engine are derived from IReferenceCounted, and so they are reference counted.
//! Base class of most objects of the Irrlicht Engine.
/** This class provides reference counting through the methods grab() and drop().
It also is able to store a debug string for every instance of an object.
Most objects of the Irrlicht
Engine are derived from IReferenceCounted, and so they are reference counted.
When you create an object in the Irrlicht engine, calling a method
which starts with 'create', an object is created, and you get a pointer
to the new object. If you no longer need the object, you have
to call drop(). This will destroy the object, if grab() was not called
in another part of you program, because this part still needs the object.
Note, that you only need to call drop() to the object, if you created it,
and the method had a 'create' in it.
When you create an object in the Irrlicht engine, calling a method
which starts with 'create', an object is created, and you get a pointer
to the new object. If you no longer need the object, you have
to call drop(). This will destroy the object, if grab() was not called
in another part of you program, because this part still needs the object.
Note, that you only need to call drop() to the object, if you created it,
and the method had a 'create' in it.
A simple example:
A simple example:
If you want to create a texture, you may want to call an imaginable method
IDriver::createTexture. You call
ITexture* texture = driver->createTexture(dimension2d<u32>(128, 128));
If you no longer need the texture, call texture->drop().
If you want to load a texture, you may want to call imaginable method
IDriver::loadTexture. You do this like
ITexture* texture = driver->loadTexture("example.jpg");
You will not have to drop the pointer to the loaded texture, because
the name of the method does not start with 'create'. The texture
is stored somewhere by the driver.
*/
class IReferenceCounted
{
public:
If you want to create a texture, you may want to call an imaginable method
IDriver::createTexture. You call
ITexture* texture = driver->createTexture(dimension2d<u32>(128, 128));
If you no longer need the texture, call texture->drop().
If you want to load a texture, you may want to call imaginable method
IDriver::loadTexture. You do this like
ITexture* texture = driver->loadTexture("example.jpg");
You will not have to drop the pointer to the loaded texture, because
the name of the method does not start with 'create'. The texture
is stored somewhere by the driver.
*/
class IReferenceCounted
{
public:
//! Constructor.
IReferenceCounted()
: DebugName(0), ReferenceCounter(1)
IReferenceCounted() :
DebugName(0), ReferenceCounter(1)
{
}
@ -118,8 +117,7 @@ namespace irr
_IRR_DEBUG_BREAK_IF(ReferenceCounter <= 0)
--ReferenceCounter;
if (!ReferenceCounter)
{
if (!ReferenceCounter) {
delete this;
return true;
}
@ -138,29 +136,27 @@ namespace irr
/** The Debugname may only be set and changed by the object
itself. This method should only be used in Debug mode.
\return Returns a string, previously set by setDebugName(); */
const c8* getDebugName() const
const c8 *getDebugName() const
{
return DebugName;
}
protected:
protected:
//! Sets the debug name of the object.
/** The Debugname may only be set and changed by the object
itself. This method should only be used in Debug mode.
\param newName: New debug name to set. */
void setDebugName(const c8* newName)
void setDebugName(const c8 *newName)
{
DebugName = newName;
}
private:
private:
//! The debug name.
const c8* DebugName;
const c8 *DebugName;
//! The reference counter. Mutable to do reference counting on const objects.
mutable s32 ReferenceCounter;
};
};
} // end namespace irr

65
include/IRenderTarget.h
View File

@ -12,43 +12,43 @@ namespace irr
{
namespace video
{
class ITexture;
class ITexture;
//! Enumeration of cube texture surfaces
enum E_CUBE_SURFACE
{
//! Enumeration of cube texture surfaces
enum E_CUBE_SURFACE
{
ECS_POSX = 0,
ECS_NEGX,
ECS_POSY,
ECS_NEGY,
ECS_POSZ,
ECS_NEGZ
};
//! Interface of a Render Target.
class IRenderTarget : public virtual IReferenceCounted
{
public:
};
//! Interface of a Render Target.
class IRenderTarget : public virtual IReferenceCounted
{
public:
//! constructor
IRenderTarget() : DepthStencil(0), DriverType(EDT_NULL)
IRenderTarget() :
DepthStencil(0), DriverType(EDT_NULL)
{
}
//! Returns an array of previously set textures.
const core::array<ITexture*>& getTexture() const
const core::array<ITexture *> &getTexture() const
{
return Textures;
}
//! Returns a of previously set depth / depth-stencil texture.
ITexture* getDepthStencil() const
ITexture *getDepthStencil() const
{
return DepthStencil;
}
//! Returns an array of active surface for cube textures
const core::array<E_CUBE_SURFACE>& getCubeSurfaces() const
const core::array<E_CUBE_SURFACE> &getCubeSurfaces() const
{
return CubeSurfaces;
}
@ -60,34 +60,28 @@ namespace video
or depth-stencil buffer. You can pass getDepthStencil() if you don't want to change it.
\param cubeSurfaces When rendering to cube textures, set the surface to be used for each texture. Can be empty otherwise.
*/
void setTexture(const core::array<ITexture*>& texture, ITexture* depthStencil, const core::array<E_CUBE_SURFACE>& cubeSurfaces = core::array<E_CUBE_SURFACE>())
void setTexture(const core::array<ITexture *> &texture, ITexture *depthStencil, const core::array<E_CUBE_SURFACE> &cubeSurfaces = core::array<E_CUBE_SURFACE>())
{
setTextures(texture.const_pointer(), texture.size(), depthStencil, cubeSurfaces.const_pointer(), cubeSurfaces.size());
}
//! Sets one texture + depthStencil
//! You can pass getDepthStencil() for depthStencil if you don't want to change that one
void setTexture(ITexture* texture, ITexture* depthStencil)
{
if ( texture )
void setTexture(ITexture *texture, ITexture *depthStencil)
{
if (texture) {
setTextures(&texture, 1, depthStencil);
}
else
{
} else {
setTextures(0, 0, depthStencil);
}
}
//! Set one cube surface texture.
void setTexture(ITexture* texture, ITexture* depthStencil, E_CUBE_SURFACE cubeSurface)
{
if ( texture )
void setTexture(ITexture *texture, ITexture *depthStencil, E_CUBE_SURFACE cubeSurface)
{
if (texture) {
setTextures(&texture, 1, depthStencil, &cubeSurface, 1);
}
else
{
} else {
setTextures(0, 0, depthStencil, &cubeSurface, 1);
}
}
@ -98,17 +92,16 @@ namespace video
return DriverType;
}
protected:
protected:
//! Set multiple textures.
// NOTE: working with pointers instead of arrays to avoid unnecessary memory allocations for the single textures case
virtual void setTextures(ITexture* const * textures, u32 numTextures, ITexture* depthStencil, const E_CUBE_SURFACE* cubeSurfaces=0, u32 numCubeSurfaces=0) = 0;
virtual void setTextures(ITexture *const *textures, u32 numTextures, ITexture *depthStencil, const E_CUBE_SURFACE *cubeSurfaces = 0, u32 numCubeSurfaces = 0) = 0;
//! Textures assigned to render target.
core::array<ITexture*> Textures;
core::array<ITexture *> Textures;
//! Depth or packed depth-stencil texture assigned to render target.
ITexture* DepthStencil;
ITexture *DepthStencil;
//! Active surface of cube textures
core::array<E_CUBE_SURFACE> CubeSurfaces;
@ -116,11 +109,11 @@ namespace video
//! Driver type of render target.
E_DRIVER_TYPE DriverType;
private:
private:
// no copying (IReferenceCounted still allows that for reasons which take some time to work around)
IRenderTarget(const IRenderTarget&);
IRenderTarget& operator=(const IRenderTarget&);
};
IRenderTarget(const IRenderTarget &);
IRenderTarget &operator=(const IRenderTarget &);
};
}
}

14
include/ISceneCollisionManager.h
View File

@ -13,12 +13,11 @@ namespace irr
namespace scene
{
class ICameraSceneNode;
class ISceneCollisionManager : public virtual IReferenceCounted
{
public:
class ICameraSceneNode;
class ISceneCollisionManager : public virtual IReferenceCounted
{
public:
//! Returns a 3d ray which would go through the 2d screen coordinates.
/** \param pos: Screen coordinates in pixels.
\param camera: Camera from which the ray starts. If null, the
@ -27,9 +26,8 @@ namespace scene
at a length of the far value of the camera at a position which
would be behind the 2d screen coordinates. */
virtual core::line3d<f32> getRayFromScreenCoordinates(
const core::position2d<s32>& pos, const ICameraSceneNode* camera = 0) = 0;
};
const core::position2d<s32> &pos, const ICameraSceneNode *camera = 0) = 0;
};
} // end namespace scene
} // end namespace irr

214
include/ISceneManager.h
View File

@ -17,51 +17,51 @@
namespace irr
{
struct SKeyMap;
struct SEvent;
struct SKeyMap;
struct SEvent;
namespace io
{
class IReadFile;
class IAttributes;
class IWriteFile;
class IFileSystem;
class IReadFile;
class IAttributes;
class IWriteFile;
class IFileSystem;
} // end namespace io
namespace gui
{
class IGUIFont;
class IGUIEnvironment;
class IGUIFont;
class IGUIEnvironment;
} // end namespace gui
namespace video
{
class IVideoDriver;
class SMaterial;
class IImage;
class ITexture;
class IVideoDriver;
class SMaterial;
class IImage;
class ITexture;
} // end namespace video
namespace scene
{
//! Enumeration for render passes.
/** A parameter passed to the registerNodeForRendering() method of the ISceneManager,
specifying when the node wants to be drawn in relation to the other nodes.
Note: Despite the numbering this is not used as bit-field.
*/
enum E_SCENE_NODE_RENDER_PASS
{
//! Enumeration for render passes.
/** A parameter passed to the registerNodeForRendering() method of the ISceneManager,
specifying when the node wants to be drawn in relation to the other nodes.
Note: Despite the numbering this is not used as bit-field.
*/
enum E_SCENE_NODE_RENDER_PASS
{
//! No pass currently active
ESNRP_NONE =0,
ESNRP_NONE = 0,
//! Camera pass. The active view is set up here. The very first pass.
ESNRP_CAMERA =1,
ESNRP_CAMERA = 1,
//! In this pass, lights are transformed into camera space and added to the driver
ESNRP_LIGHT =2,
ESNRP_LIGHT = 2,
//! This is used for sky boxes.
ESNRP_SKY_BOX =4,
ESNRP_SKY_BOX = 4,
//! All normal objects can use this for registering themselves.
/** This value will never be returned by
@ -76,57 +76,56 @@ namespace scene
render() method call getSceneNodeRenderPass() to find out the
current render pass and render only the corresponding parts of
the node. */
ESNRP_AUTOMATIC =24,
ESNRP_AUTOMATIC = 24,
//! Solid scene nodes or special scene nodes without materials.
ESNRP_SOLID =8,
ESNRP_SOLID = 8,
//! Transparent scene nodes, drawn after solid nodes. They are sorted from back to front and drawn in that order.
ESNRP_TRANSPARENT =16,
ESNRP_TRANSPARENT = 16,
//! Transparent effect scene nodes, drawn after Transparent nodes. They are sorted from back to front and drawn in that order.
ESNRP_TRANSPARENT_EFFECT =32,
ESNRP_TRANSPARENT_EFFECT = 32,
//! Drawn after the solid nodes, before the transparent nodes, the time for drawing shadow volumes
ESNRP_SHADOW =64,
ESNRP_SHADOW = 64,
//! Drawn after transparent effect nodes. For custom gui's. Unsorted (in order nodes registered themselves).
ESNRP_GUI = 128
};
};
class IAnimatedMesh;
class IAnimatedMeshSceneNode;
class IBillboardSceneNode;
class ICameraSceneNode;
class IDummyTransformationSceneNode;
class IMesh;
class IMeshBuffer;
class IMeshCache;
class ISceneCollisionManager;
class IMeshLoader;
class IMeshManipulator;
class IMeshSceneNode;
class ISceneNode;
class ISceneNodeFactory;
//! The Scene Manager manages scene nodes, mesh resources, cameras and all the other stuff.
/** All Scene nodes can be created only here.
A scene node is a node in the hierarchical scene graph. Every scene node
may have children, which are other scene nodes. Children move relative
the their parents position. If the parent of a node is not visible, its
children won't be visible, too. In this way, it is for example easily
possible to attach a light to a moving car or to place a walking
character on a moving platform on a moving ship.
The SceneManager is also able to load 3d mesh files of different
formats. Take a look at getMesh() to find out what formats are
supported. If these formats are not enough, use
addExternalMeshLoader() to add new formats to the engine.
*/
class ISceneManager : public virtual IReferenceCounted
{
public:
class IAnimatedMesh;
class IAnimatedMeshSceneNode;
class IBillboardSceneNode;
class ICameraSceneNode;
class IDummyTransformationSceneNode;
class IMesh;
class IMeshBuffer;
class IMeshCache;
class ISceneCollisionManager;
class IMeshLoader;
class IMeshManipulator;
class IMeshSceneNode;
class ISceneNode;
class ISceneNodeFactory;
//! The Scene Manager manages scene nodes, mesh resources, cameras and all the other stuff.
/** All Scene nodes can be created only here.
A scene node is a node in the hierarchical scene graph. Every scene node
may have children, which are other scene nodes. Children move relative
the their parents position. If the parent of a node is not visible, its
children won't be visible, too. In this way, it is for example easily
possible to attach a light to a moving car or to place a walking
character on a moving platform on a moving ship.
The SceneManager is also able to load 3d mesh files of different
formats. Take a look at getMesh() to find out what formats are
supported. If these formats are not enough, use
addExternalMeshLoader() to add new formats to the engine.
*/
class ISceneManager : public virtual IReferenceCounted
{
public:
//! Get pointer to an animatable mesh. Loads the file if not loaded already.
/**
* If you want to remove a loaded mesh from the cache again, use removeMesh().
@ -319,18 +318,18 @@ namespace scene
* \return Null if failed, otherwise pointer to the mesh.
* This pointer should not be dropped. See IReferenceCounted::drop() for more information.
**/
virtual IAnimatedMesh* getMesh(io::IReadFile* file) = 0;
virtual IAnimatedMesh *getMesh(io::IReadFile *file) = 0;
//! Get interface to the mesh cache which is shared between all existing scene managers.
/** With this interface, it is possible to manually add new loaded
meshes (if ISceneManager::getMesh() is not sufficient), to remove them and to iterate
through already loaded meshes. */
virtual IMeshCache* getMeshCache() = 0;
virtual IMeshCache *getMeshCache() = 0;
//! Get the video driver.
/** \return Pointer to the video Driver.
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual video::IVideoDriver* getVideoDriver() = 0;
virtual video::IVideoDriver *getVideoDriver() = 0;
//! Adds a scene node for rendering an animated mesh model.
/** \param mesh: Pointer to the loaded animated mesh to be displayed.
@ -343,12 +342,12 @@ namespace scene
\param alsoAddIfMeshPointerZero: Add the scene node even if a 0 pointer is passed.
\return Pointer to the created scene node.
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual IAnimatedMeshSceneNode* addAnimatedMeshSceneNode(IAnimatedMesh* mesh,
ISceneNode* parent=0, s32 id=-1,
const core::vector3df& position = core::vector3df(0,0,0),
const core::vector3df& rotation = core::vector3df(0,0,0),
const core::vector3df& scale = core::vector3df(1.0f, 1.0f, 1.0f),
bool alsoAddIfMeshPointerZero=false) = 0;
virtual IAnimatedMeshSceneNode *addAnimatedMeshSceneNode(IAnimatedMesh *mesh,
ISceneNode *parent = 0, s32 id = -1,
const core::vector3df &position = core::vector3df(0, 0, 0),
const core::vector3df &rotation = core::vector3df(0, 0, 0),
const core::vector3df &scale = core::vector3df(1.0f, 1.0f, 1.0f),
bool alsoAddIfMeshPointerZero = false) = 0;
//! Adds a scene node for rendering a static mesh.
/** \param mesh: Pointer to the loaded static mesh to be displayed.
@ -361,11 +360,11 @@ namespace scene
\param alsoAddIfMeshPointerZero: Add the scene node even if a 0 pointer is passed.
\return Pointer to the created scene node.
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual IMeshSceneNode* addMeshSceneNode(IMesh* mesh, ISceneNode* parent=0, s32 id=-1,
const core::vector3df& position = core::vector3df(0,0,0),
const core::vector3df& rotation = core::vector3df(0,0,0),
const core::vector3df& scale = core::vector3df(1.0f, 1.0f, 1.0f),
bool alsoAddIfMeshPointerZero=false) = 0;
virtual IMeshSceneNode *addMeshSceneNode(IMesh *mesh, ISceneNode *parent = 0, s32 id = -1,
const core::vector3df &position = core::vector3df(0, 0, 0),
const core::vector3df &rotation = core::vector3df(0, 0, 0),
const core::vector3df &scale = core::vector3df(1.0f, 1.0f, 1.0f),
bool alsoAddIfMeshPointerZero = false) = 0;
//! Adds a camera scene node to the scene graph and sets it as active camera.
/** This camera does not react on user input.
@ -384,10 +383,10 @@ namespace scene
Make sure you always have one active camera.
\return Pointer to interface to camera if successful, otherwise 0.
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual ICameraSceneNode* addCameraSceneNode(ISceneNode* parent = 0,
const core::vector3df& position = core::vector3df(0,0,0),
const core::vector3df& lookat = core::vector3df(0,0,100),
s32 id=-1, bool makeActive=true) = 0;
virtual ICameraSceneNode *addCameraSceneNode(ISceneNode *parent = 0,
const core::vector3df &position = core::vector3df(0, 0, 0),
const core::vector3df &lookat = core::vector3df(0, 0, 100),
s32 id = -1, bool makeActive = true) = 0;
//! Adds a billboard scene node to the scene graph.
/** A billboard is like a 3d sprite: A 2d element,
@ -408,9 +407,9 @@ namespace scene
\return Pointer to the billboard if successful, otherwise NULL.
This pointer should not be dropped. See
IReferenceCounted::drop() for more information. */
virtual IBillboardSceneNode* addBillboardSceneNode(ISceneNode* parent = 0,
const core::dimension2d<f32>& size = core::dimension2d<f32>(10.0f, 10.0f),
const core::vector3df& position = core::vector3df(0,0,0), s32 id=-1,
virtual IBillboardSceneNode *addBillboardSceneNode(ISceneNode *parent = 0,
const core::dimension2d<f32> &size = core::dimension2d<f32>(10.0f, 10.0f),
const core::vector3df &position = core::vector3df(0, 0, 0), s32 id = -1,
video::SColor colorTop = 0xFFFFFFFF, video::SColor colorBottom = 0xFFFFFFFF) = 0;
//! Adds an empty scene node to the scene graph.
@ -418,7 +417,7 @@ namespace scene
or structuring the scene graph.
\return Pointer to the created scene node.
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual ISceneNode* addEmptySceneNode(ISceneNode* parent=0, s32 id=-1) = 0;
virtual ISceneNode *addEmptySceneNode(ISceneNode *parent = 0, s32 id = -1) = 0;
//! Adds a dummy transformation scene node to the scene graph.
/** This scene node does not render itself, and does not respond to set/getPosition,
@ -427,8 +426,8 @@ namespace scene
anywhere into the scene graph.
\return Pointer to the created scene node.
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual IDummyTransformationSceneNode* addDummyTransformationSceneNode(
ISceneNode* parent=0, s32 id=-1) = 0;
virtual IDummyTransformationSceneNode *addDummyTransformationSceneNode(
ISceneNode *parent = 0, s32 id = -1) = 0;
//! Gets the root scene node.
/** This is the scene node which is parent
@ -437,7 +436,7 @@ namespace scene
be removed from the scene.
\return Pointer to the root scene node.
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual ISceneNode* getRootSceneNode() = 0;
virtual ISceneNode *getRootSceneNode() = 0;
//! Get the first scene node with the specified id.
/** \param id: The id to search for
@ -447,7 +446,7 @@ namespace scene
\return Pointer to the first scene node with this id,
and null if no scene node could be found.
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual ISceneNode* getSceneNodeFromId(s32 id, ISceneNode* start=0) = 0;
virtual ISceneNode *getSceneNodeFromId(s32 id, ISceneNode *start = 0) = 0;
//! Get the first scene node with the specified name.
/** \param name: The name to search for
@ -457,7 +456,7 @@ namespace scene
\return Pointer to the first scene node with this id,
and null if no scene node could be found.
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual ISceneNode* getSceneNodeFromName(const c8* name, ISceneNode* start=0) = 0;
virtual ISceneNode *getSceneNodeFromName(const c8 *name, ISceneNode *start = 0) = 0;
//! Get the first scene node with the specified type.
/** \param type: The type to search for
@ -467,7 +466,7 @@ namespace scene
\return Pointer to the first scene node with this type,
and null if no scene node could be found.
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual ISceneNode* getSceneNodeFromType(scene::ESCENE_NODE_TYPE type, ISceneNode* start=0) = 0;
virtual ISceneNode *getSceneNodeFromType(scene::ESCENE_NODE_TYPE type, ISceneNode *start = 0) = 0;
//! Get scene nodes by type.
/** \param type: Type of scene node to find (ESNT_ANY will return all child nodes).
@ -476,19 +475,19 @@ namespace scene
node are checked (recursively, so also children of children, etc). If null is specified,
the root scene node is taken as start-node. */
virtual void getSceneNodesFromType(ESCENE_NODE_TYPE type,
core::array<scene::ISceneNode*>& outNodes,
ISceneNode* start=0) = 0;
core::array<scene::ISceneNode *> &outNodes,
ISceneNode *start = 0) = 0;
//! Get the current active camera.
/** \return The active camera is returned. Note that this can
be NULL, if there was no camera created yet.
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual ICameraSceneNode* getActiveCamera() const =0;
virtual ICameraSceneNode *getActiveCamera() const = 0;
//! Sets the currently active camera.
/** The previous active camera will be deactivated.
\param camera: The new camera which should be active. */
virtual void setActiveCamera(ICameraSceneNode* camera) = 0;
virtual void setActiveCamera(ICameraSceneNode *camera) = 0;
//! Registers a node for rendering it at a specific time.
/** This method should only be used by SceneNodes when they get a
@ -501,7 +500,7 @@ namespace scene
Note: This is _not_ a bitfield. If you want to register a note for several render passes, then
call this function once for each pass.
\return scene will be rendered ( passed culling ) */
virtual u32 registerNodeForRendering(ISceneNode* node,
virtual u32 registerNodeForRendering(ISceneNode *node,
E_SCENE_NODE_RENDER_PASS pass = ESNRP_AUTOMATIC) = 0;
//! Clear all nodes which are currently registered for rendering
@ -524,7 +523,7 @@ namespace scene
Using this method it is also possible to override built-in mesh loaders with
newer or updated versions without the need to recompile the engine.
\param externalLoader: Implementation of a new mesh loader. */
virtual void addExternalMeshLoader(IMeshLoader* externalLoader) = 0;
virtual void addExternalMeshLoader(IMeshLoader *externalLoader) = 0;
//! Returns the number of mesh loaders supported by Irrlicht at this time
virtual u32 getMeshLoaderCount() const = 0;
@ -533,17 +532,17 @@ namespace scene
/** \param index The index of the loader to retrieve. This parameter is an 0-based
array index.
\return A pointer to the specified loader, 0 if the index is incorrect. */
virtual IMeshLoader* getMeshLoader(u32 index) const = 0;
virtual IMeshLoader *getMeshLoader(u32 index) const = 0;
//! Get pointer to the scene collision manager.
/** \return Pointer to the collision manager
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual ISceneCollisionManager* getSceneCollisionManager() = 0;
virtual ISceneCollisionManager *getSceneCollisionManager() = 0;
//! Get pointer to the mesh manipulator.
/** \return Pointer to the mesh manipulator
This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual IMeshManipulator* getMeshManipulator() = 0;
virtual IMeshManipulator *getMeshManipulator() = 0;
//! Adds a scene node to the deletion queue.
/** The scene node is immediately
@ -554,12 +553,12 @@ namespace scene
deletion queue is not necessary.
See ISceneManager::createDeleteAnimator() for details.
\param node: Node to delete. */
virtual void addToDeletionQueue(ISceneNode* node) = 0;
virtual void addToDeletionQueue(ISceneNode *node) = 0;
//! Posts an input event to the environment.
/** Usually you do not have to
use this method, it is used by the internal engine. */
virtual bool postEventFromUser(const SEvent& event) = 0;
virtual bool postEventFromUser(const SEvent &event) = 0;
//! Clears the whole scene.
/** All scene nodes are removed. */
@ -568,7 +567,7 @@ namespace scene
//! Get interface to the parameters set in this scene.
/** String parameters can be used by plugins and mesh loaders.
See COLLADA_CREATE_SCENE_INSTANCES and DMF_USE_MATERIALS_DIRS */
virtual io::IAttributes* getParameters() = 0;
virtual io::IAttributes *getParameters() = 0;
//! Get current render pass.
/** All scene nodes are being rendered in a specific order.
@ -598,24 +597,24 @@ namespace scene
If you no longer need the new scene manager, you should call
ISceneManager::drop().
See IReferenceCounted::drop() for more information. */
virtual ISceneManager* createNewSceneManager(bool cloneContent=false) = 0;
virtual ISceneManager *createNewSceneManager(bool cloneContent = false) = 0;
//! Get a skinned mesh, which is not available as header-only code
/** Note: You need to drop() the pointer after use again, see IReferenceCounted::drop()
for details. */
virtual ISkinnedMesh* createSkinnedMesh() = 0;
virtual ISkinnedMesh *createSkinnedMesh() = 0;
//! Sets ambient color of the scene
virtual void setAmbientLight(const video::SColorf &ambientColor) = 0;
//! Get ambient color of the scene
virtual const video::SColorf& getAmbientLight() const = 0;
virtual const video::SColorf &getAmbientLight() const = 0;
//! Get current render pass.
virtual E_SCENE_NODE_RENDER_PASS getCurrentRenderPass() const =0;
virtual E_SCENE_NODE_RENDER_PASS getCurrentRenderPass() const = 0;
//! Set current render pass.
virtual void setCurrentRenderPass(E_SCENE_NODE_RENDER_PASS nextPass) =0;
virtual void setCurrentRenderPass(E_SCENE_NODE_RENDER_PASS nextPass) = 0;
//! Check if node is culled in current view frustum
/** Please note that depending on the used culling method this
@ -626,9 +625,8 @@ namespace scene
\param node The scene node which is checked for culling.
\return True if node is not visible in the current scene, else
false. */
virtual bool isCulled(const ISceneNode* node) const =0;
};
virtual bool isCulled(const ISceneNode *node) const = 0;
};
} // end namespace scene
} // end namespace irr

160
include/ISceneNode.h
View File

@ -21,30 +21,30 @@ namespace irr
{
namespace scene
{
class ISceneNode;
class ISceneManager;
class ISceneNode;
class ISceneManager;
//! Typedef for list of scene nodes
typedef std::list<ISceneNode*> ISceneNodeList;
//! Scene node interface.
/** A scene node is a node in the hierarchical scene graph. Every scene
node may have children, which are also scene nodes. Children move
relative to their parent's position. If the parent of a node is not
visible, its children won't be visible either. In this way, it is for
example easily possible to attach a light to a moving car, or to place
a walking character on a moving platform on a moving ship.
*/
class ISceneNode : virtual public IReferenceCounted
{
public:
//! Typedef for list of scene nodes
typedef std::list<ISceneNode *> ISceneNodeList;
//! Scene node interface.
/** A scene node is a node in the hierarchical scene graph. Every scene
node may have children, which are also scene nodes. Children move
relative to their parent's position. If the parent of a node is not
visible, its children won't be visible either. In this way, it is for
example easily possible to attach a light to a moving car, or to place
a walking character on a moving platform on a moving ship.
*/
class ISceneNode : virtual public IReferenceCounted
{
public:
//! Constructor
ISceneNode(ISceneNode* parent, ISceneManager* mgr, s32 id=-1,
const core::vector3df& position = core::vector3df(0,0,0),
const core::vector3df& rotation = core::vector3df(0,0,0),
const core::vector3df& scale = core::vector3df(1.0f, 1.0f, 1.0f))
: RelativeTranslation(position), RelativeRotation(rotation), RelativeScale(scale),
ISceneNode(ISceneNode *parent, ISceneManager *mgr, s32 id = -1,
const core::vector3df &position = core::vector3df(0, 0, 0),
const core::vector3df &rotation = core::vector3df(0, 0, 0),
const core::vector3df &scale = core::vector3df(1.0f, 1.0f, 1.0f)) :
RelativeTranslation(position),
RelativeRotation(rotation), RelativeScale(scale),
Parent(0), SceneManager(mgr), ID(id),
AutomaticCullingState(EAC_BOX), DebugDataVisible(EDS_OFF),
IsVisible(true), IsDebugObject(false)
@ -55,7 +55,6 @@ namespace scene
updateAbsolutePosition();
}
//! Destructor
virtual ~ISceneNode()
{
@ -63,7 +62,6 @@ namespace scene
removeAll();
}
//! This method is called just before the rendering process of the whole scene.
/** Nodes may register themselves in the render pipeline during this call,
precalculate the geometry which should be rendered, and prevent their
@ -80,15 +78,13 @@ namespace scene
*/
virtual void OnRegisterSceneNode()
{
if (IsVisible)
{
if (IsVisible) {
ISceneNodeList::iterator it = Children.begin();
for (; it != Children.end(); ++it)
(*it)->OnRegisterSceneNode();
}
}
//! OnAnimate() is called just before rendering the whole scene.
/** Nodes may calculate or store animations here, and may do other useful things,
depending on what they are. Also, OnAnimate() should be called for all
@ -97,8 +93,7 @@ namespace scene
\param timeMs Current time in milliseconds. */
virtual void OnAnimate(u32 timeMs)
{
if (IsVisible)
{
if (IsVisible) {
// update absolute position
updateAbsolutePosition();
@ -110,11 +105,9 @@ namespace scene
}
}
//! Renders the node.
virtual void render() = 0;
//! Returns the name of the node.
/** \return Name as character string. */
virtual const std::optional<std::string> &getName() const
@ -129,7 +122,6 @@ namespace scene
Name = name;
}
//! Get the axis aligned, not transformed bounding box of this node.
/** This means that if this node is an animated 3d character,
moving in a room, the bounding box will always be around the
@ -138,8 +130,7 @@ namespace scene
getAbsoluteTransformation() or simply use
getTransformedBoundingBox(), which does the same.
\return The non-transformed bounding box. */
virtual const core::aabbox3d<f32>& getBoundingBox() const = 0;
virtual const core::aabbox3d<f32> &getBoundingBox() const = 0;
//! Get the axis aligned, transformed and animated absolute bounding box of this node.
/** Note: The result is still an axis-aligned bounding box, so it's size
@ -157,12 +148,12 @@ namespace scene
/** Note: The result is _not_ identical to getTransformedBoundingBox().getEdges(),
but getting an aabbox3d of these edges would then be identical.
\param edges Receives an array with the transformed edges */
virtual void getTransformedBoundingBoxEdges(core::array< core::vector3d<f32> >& edges) const
virtual void getTransformedBoundingBoxEdges(core::array<core::vector3d<f32>> &edges) const
{
edges.set_used(8);
getBoundingBox().getEdges( edges.pointer() );
for ( u32 i=0; i<8; ++i )
AbsoluteTransformation.transformVect( edges[i] );
getBoundingBox().getEdges(edges.pointer());
for (u32 i = 0; i < 8; ++i)
AbsoluteTransformation.transformVect(edges[i]);
}
//! Get the absolute transformation of the node. Is recalculated every OnAnimate()-call.
@ -172,12 +163,11 @@ namespace scene
update usually happens once per frame in OnAnimate. You can enforce
an update with updateAbsolutePosition().
\return The absolute transformation matrix. */
virtual const core::matrix4& getAbsoluteTransformation() const
virtual const core::matrix4 &getAbsoluteTransformation() const
{
return AbsoluteTransformation;
}
//! Returns the relative transformation of the scene node.
/** The relative transformation is stored internally as 3
vectors: translation, rotation and scale. To get the relative
@ -189,8 +179,7 @@ namespace scene
mat.setRotationDegrees(RelativeRotation);
mat.setTranslation(RelativeTranslation);
if (RelativeScale != core::vector3df(1.f,1.f,1.f))
{
if (RelativeScale != core::vector3df(1.f, 1.f, 1.f)) {
core::matrix4 smat;
smat.setScale(RelativeScale);
mat *= smat;
@ -199,7 +188,6 @@ namespace scene
return mat;
}
//! Returns whether the node should be visible (if all of its parents are visible).
/** This is only an option set by the user, but has nothing to
do with geometry culling
@ -215,10 +203,10 @@ namespace scene
false if this or any parent node is invisible. */
virtual bool isTrulyVisible() const
{
if(!IsVisible)
if (!IsVisible)
return false;
if(!Parent)
if (!Parent)
return true;
return Parent->isTrulyVisible();
@ -234,7 +222,6 @@ namespace scene
IsVisible = isVisible;
}
//! Get the id of the scene node.
/** This id can be used to identify the node.
\return The id. */
@ -243,7 +230,6 @@ namespace scene
return ID;
}
//! Sets the id of the scene node.
/** This id can be used to identify the node.
\param id The new id. */
@ -252,15 +238,13 @@ namespace scene
ID = id;
}
//! Adds a child to this scene node.
/** If the scene node already has a parent it is first removed
from the other parent.
\param child A pointer to the new child. */
virtual void addChild(ISceneNode* child)
{
if (child && (child != this))
virtual void addChild(ISceneNode *child)
{
if (child && (child != this)) {
// Change scene manager?
if (SceneManager != child->SceneManager)
child->setSceneManager(SceneManager);
@ -273,13 +257,12 @@ namespace scene
}
}
//! Removes a child from this scene node.
/**
\param child A pointer to the child which shall be removed.
\return True if the child was removed, and false if not,
e.g. because it belongs to a different parent or no parent. */
virtual bool removeChild(ISceneNode* child)
virtual bool removeChild(ISceneNode *child)
{
if (child->Parent != this)
return false;
@ -294,7 +277,6 @@ namespace scene
return true;
}
//! Removes all children of this scene node
/** The scene nodes found in the children list are also dropped
and might be deleted if no other grab exists on them.
@ -309,7 +291,6 @@ namespace scene
Children.clear();
}
//! Removes this scene node from the scene
/** If no other grab exists for this node, it will be deleted.
*/
@ -319,7 +300,6 @@ namespace scene
Parent->removeChild(this);
}
//! Returns the material based on the zero based index i.
/** To get the amount of materials used by this scene node, use
getMaterialCount(). This function is needed for inserting the
@ -328,12 +308,11 @@ namespace scene
directly modify the material of a scene node.
\param num Zero based index. The maximal value is getMaterialCount() - 1.
\return The material at that index. */
virtual video::SMaterial& getMaterial(u32 num)
virtual video::SMaterial &getMaterial(u32 num)
{
return video::IdentityMaterial;
}
//! Get amount of materials used by this scene node.
/** \return Current amount of materials of this scene node. */
virtual u32 getMaterialCount() const
@ -341,76 +320,69 @@ namespace scene
return 0;
}
//! Execute a function on all materials of this scene node.
/** Useful for setting material properties, e.g. if you want the whole
mesh to be affected by light. */
template <typename F>
void forEachMaterial(F &&fn) {
void forEachMaterial(F &&fn)
{
for (u32 i = 0; i < getMaterialCount(); i++) {
fn(getMaterial(i));
}
}
//! Gets the scale of the scene node relative to its parent.
/** This is the scale of this node relative to its parent.
If you want the absolute scale, use
getAbsoluteTransformation().getScale()
\return The scale of the scene node. */
virtual const core::vector3df& getScale() const
virtual const core::vector3df &getScale() const
{
return RelativeScale;
}
//! Sets the relative scale of the scene node.
/** \param scale New scale of the node, relative to its parent. */
virtual void setScale(const core::vector3df& scale)
virtual void setScale(const core::vector3df &scale)
{
RelativeScale = scale;
}
//! Gets the rotation of the node relative to its parent.
/** Note that this is the relative rotation of the node.
If you want the absolute rotation, use
getAbsoluteTransformation().getRotation()
\return Current relative rotation of the scene node. */
virtual const core::vector3df& getRotation() const
virtual const core::vector3df &getRotation() const
{
return RelativeRotation;
}
//! Sets the rotation of the node relative to its parent.
/** This only modifies the relative rotation of the node.
\param rotation New rotation of the node in degrees. */
virtual void setRotation(const core::vector3df& rotation)
virtual void setRotation(const core::vector3df &rotation)
{
RelativeRotation = rotation;
}
//! Gets the position of the node relative to its parent.
/** Note that the position is relative to the parent. If you want
the position in world coordinates, use getAbsolutePosition() instead.
\return The current position of the node relative to the parent. */
virtual const core::vector3df& getPosition() const
virtual const core::vector3df &getPosition() const
{
return RelativeTranslation;
}
//! Sets the position of the node relative to its parent.
/** Note that the position is relative to the parent.
\param newpos New relative position of the scene node. */
virtual void setPosition(const core::vector3df& newpos)
virtual void setPosition(const core::vector3df &newpos)
{
RelativeTranslation = newpos;
}
//! Gets the absolute position of the node in world coordinates.
/** If you want the position of the node relative to its parent,
use getPosition() instead.
@ -425,19 +397,17 @@ namespace scene
return AbsoluteTransformation.getTranslation();
}
//! Set a culling style or disable culling completely.
/** Box cullling (EAC_BOX) is set by default. Note that not
all SceneNodes support culling and that some nodes always cull
their geometry because it is their only reason for existence,
for example the OctreeSceneNode.
\param state The culling state to be used. Check E_CULLING_TYPE for possible values.*/
void setAutomaticCulling( u32 state)
void setAutomaticCulling(u32 state)
{
AutomaticCullingState = state;
}
//! Gets the automatic culling state.
/** \return The automatic culling state. */
u32 getAutomaticCulling() const
@ -445,7 +415,6 @@ namespace scene
return AutomaticCullingState;
}
//! Sets if debug data like bounding boxes should be drawn.
/** A bitwise OR of the types from @ref irr::scene::E_DEBUG_SCENE_TYPE.
Please note that not all scene nodes support all debug data types.
@ -463,7 +432,6 @@ namespace scene
return DebugDataVisible;
}
//! Sets if this scene node is a debug object.
/** Debug objects have some special properties, for example they can be easily
excluded from collision detection or from serialization, etc. */
@ -472,7 +440,6 @@ namespace scene
IsDebugObject = debugObject;
}
//! Returns if this scene node is a debug object.
/** Debug objects have some special properties, for example they can be easily
excluded from collision detection or from serialization, etc.
@ -482,18 +449,16 @@ namespace scene
return IsDebugObject;
}
//! Returns a const reference to the list of all children.
/** \return The list of all children of this node. */
const std::list<ISceneNode*>& getChildren() const
const std::list<ISceneNode *> &getChildren() const
{
return Children;
}
//! Changes the parent of the scene node.
/** \param newParent The new parent to be used. */
virtual void setParent(ISceneNode* newParent)
virtual void setParent(ISceneNode *newParent)
{
grab();
remove();
@ -504,30 +469,25 @@ namespace scene
drop();
}
//! Updates the absolute position based on the relative and the parents position
/** Note: This does not recursively update the parents absolute positions, so if you have a deeper
hierarchy you might want to update the parents first.*/
virtual void updateAbsolutePosition()
{
if (Parent)
{
if (Parent) {
AbsoluteTransformation =
Parent->getAbsoluteTransformation() * getRelativeTransformation();
}
else
} else
AbsoluteTransformation = getRelativeTransformation();
}
//! Returns the parent of this scene node
/** \return A pointer to the parent. */
scene::ISceneNode* getParent() const
scene::ISceneNode *getParent() const
{
return Parent;
}
//! Returns type of the scene node
/** \return The type of this node. */
virtual ESCENE_NODE_TYPE getType() const
@ -539,23 +499,22 @@ namespace scene
/** \param newParent An optional new parent.
\param newManager An optional new scene manager.
\return The newly created clone of this node. */
virtual ISceneNode* clone(ISceneNode* newParent=0, ISceneManager* newManager=0)
virtual ISceneNode *clone(ISceneNode *newParent = 0, ISceneManager *newManager = 0)
{
return 0; // to be implemented by derived classes
}
//! Retrieve the scene manager for this node.
/** \return The node's scene manager. */
virtual ISceneManager* getSceneManager(void) const { return SceneManager; }
protected:
virtual ISceneManager *getSceneManager(void) const { return SceneManager; }
protected:
//! A clone function for the ISceneNode members.
/** This method can be used by clone() implementations of
derived classes
\param toCopyFrom The node from which the values are copied
\param newManager The new scene manager. */
void cloneMembers(ISceneNode* toCopyFrom, ISceneManager* newManager)
void cloneMembers(ISceneNode *toCopyFrom, ISceneManager *newManager)
{
Name = toCopyFrom->Name;
AbsoluteTransformation = toCopyFrom->AbsoluteTransformation;
@ -582,7 +541,7 @@ namespace scene
//! Sets the new scene manager for this node and all children.
//! Called by addChild when moving nodes between scene managers
void setSceneManager(ISceneManager* newManager)
void setSceneManager(ISceneManager *newManager)
{
SceneManager = newManager;
@ -607,16 +566,16 @@ namespace scene
core::vector3df RelativeScale;
//! List of all children of this node
std::list<ISceneNode*> Children;
std::list<ISceneNode *> Children;
//! Iterator pointing to this node in the parent's child list.
std::optional<ISceneNodeList::iterator> ThisIterator;
//! Pointer to the parent
ISceneNode* Parent;
ISceneNode *Parent;
//! Pointer to the scene manager
ISceneManager* SceneManager;
ISceneManager *SceneManager;
//! ID of the node.
s32 ID;
@ -632,8 +591,7 @@ namespace scene
//! Is debug object?
bool IsDebugObject;
};
};
} // end namespace scene
} // end namespace irr

10
include/IShaderConstantSetCallBack.h
View File

@ -10,8 +10,8 @@ namespace irr
{
namespace video
{
class IMaterialRendererServices;
class SMaterial;
class IMaterialRendererServices;
class SMaterial;
//! Interface making it possible to set constants for gpu programs every frame.
/** Implement this interface in an own class and pass a pointer to it to one of
@ -20,7 +20,6 @@ OnSetConstants method will be called every frame now. */
class IShaderConstantSetCallBack : public virtual IReferenceCounted
{
public:
//! Called to let the callBack know the used material (optional method)
/**
\code
@ -40,7 +39,7 @@ public:
}
\endcode
*/
virtual void OnSetMaterial(const SMaterial& material) { }
virtual void OnSetMaterial(const SMaterial &material) {}
//! Called by the engine when the vertex and/or pixel shader constants for an material renderer should be set.
/**
@ -73,9 +72,8 @@ public:
\param services: Pointer to an interface providing methods to set the constants for the shader.
\param userData: Userdata int which can be specified when creating the shader.
*/
virtual void OnSetConstants(IMaterialRendererServices* services, s32 userData) = 0;
virtual void OnSetConstants(IMaterialRendererServices *services, s32 userData) = 0;
};
} // end namespace video
} // end namespace irr

59
include/ISkinnedMesh.h
View File

@ -16,8 +16,8 @@ namespace irr
namespace scene
{
enum E_INTERPOLATION_MODE
{
enum E_INTERPOLATION_MODE
{
// constant does use the current key-values without interpolation
EIM_CONSTANT = 0,
@ -26,14 +26,12 @@ namespace scene
//! count of all available interpolation modes
EIM_COUNT
};
//! Interface for using some special functions of Skinned meshes
class ISkinnedMesh : public IAnimatedMesh
{
public:
};
//! Interface for using some special functions of Skinned meshes
class ISkinnedMesh : public IAnimatedMesh
{
public:
//! Gets joint count.
/** \return Amount of joints in the skeletal animated mesh. */
virtual u32 getJointCount() const = 0;
@ -67,7 +65,7 @@ namespace scene
virtual void setInterpolationMode(E_INTERPOLATION_MODE mode) = 0;
//! Animates this mesh's joints based on frame input
virtual void animateMesh(f32 frame, f32 blend)=0;
virtual void animateMesh(f32 frame, f32 blend) = 0;
//! Preforms a software skin on this mesh based of joint positions
virtual void skinMesh() = 0;
@ -90,10 +88,10 @@ namespace scene
struct SWeight
{
//! Index of the mesh buffer
u16 buffer_id; //I doubt 32bits is needed
u16 buffer_id; // I doubt 32bits is needed
//! Index of the vertex
u32 vertex_id; //Store global ID here
u32 vertex_id; // Store global ID here
//! Weight Strength/Percentage (0-1)
f32 strength;
@ -106,7 +104,6 @@ namespace scene
core::vector3df StaticNormal;
};
//! Animation keyframe which describes a new position
struct SPositionKey
{
@ -131,8 +128,9 @@ namespace scene
//! Joints
struct SJoint
{
SJoint() : UseAnimationFrom(0), GlobalSkinningSpace(false),
positionHint(-1),scaleHint(-1),rotationHint(-1)
SJoint() :
UseAnimationFrom(0), GlobalSkinningSpace(false),
positionHint(-1), scaleHint(-1), rotationHint(-1)
{
}
@ -143,7 +141,7 @@ namespace scene
core::matrix4 LocalMatrix;
//! List of child joints
core::array<SJoint*> Children;
core::array<SJoint *> Children;
//! List of attached meshes
core::array<u32> AttachedMeshes;
@ -168,7 +166,7 @@ namespace scene
core::vector3df Animatedscale;
core::quaternion Animatedrotation;
core::matrix4 GlobalInversedMatrix; //the x format pre-calculates this
core::matrix4 GlobalInversedMatrix; // the x format pre-calculates this
private:
//! Internal members used by CSkinnedMesh
@ -182,42 +180,41 @@ namespace scene
s32 rotationHint;
};
// Interface for the mesh loaders (finalize should lock these functions, and they should have some prefix like loader_
//Interface for the mesh loaders (finalize should lock these functions, and they should have some prefix like loader_
//these functions will use the needed arrays, set values, etc to help the loaders
// these functions will use the needed arrays, set values, etc to help the loaders
//! exposed for loaders: to add mesh buffers
virtual core::array<SSkinMeshBuffer*>& getMeshBuffers() = 0;
virtual core::array<SSkinMeshBuffer *> &getMeshBuffers() = 0;
//! exposed for loaders: joints list
virtual core::array<SJoint*>& getAllJoints() = 0;
virtual core::array<SJoint *> &getAllJoints() = 0;
//! exposed for loaders: joints list
virtual const core::array<SJoint*>& getAllJoints() const = 0;
virtual const core::array<SJoint *> &getAllJoints() const = 0;
//! loaders should call this after populating the mesh
virtual void finalize() = 0;
//! Adds a new meshbuffer to the mesh, access it as last one
virtual SSkinMeshBuffer* addMeshBuffer() = 0;
virtual SSkinMeshBuffer *addMeshBuffer() = 0;
//! Adds a new joint to the mesh, access it as last one
virtual SJoint* addJoint(SJoint *parent=0) = 0;
virtual SJoint *addJoint(SJoint *parent = 0) = 0;
//! Adds a new weight to the mesh, access it as last one
virtual SWeight* addWeight(SJoint *joint) = 0;
virtual SWeight *addWeight(SJoint *joint) = 0;
//! Adds a new position key to the mesh, access it as last one
virtual SPositionKey* addPositionKey(SJoint *joint) = 0;
virtual SPositionKey *addPositionKey(SJoint *joint) = 0;
//! Adds a new scale key to the mesh, access it as last one
virtual SScaleKey* addScaleKey(SJoint *joint) = 0;
virtual SScaleKey *addScaleKey(SJoint *joint) = 0;
//! Adds a new rotation key to the mesh, access it as last one
virtual SRotationKey* addRotationKey(SJoint *joint) = 0;
virtual SRotationKey *addRotationKey(SJoint *joint) = 0;
//! Check if the mesh is non-animated
virtual bool isStatic()=0;
};
virtual bool isStatic() = 0;
};
} // end namespace scene
} // end namespace irr

20
include/ITexture.h
View File

@ -16,7 +16,6 @@ namespace irr
namespace video
{
//! Enumeration flags used to tell the video driver with setTextureCreationFlag in which format textures should be created.
enum E_TEXTURE_CREATION_FLAG
{
@ -176,9 +175,9 @@ and write a warning or an error message to the output buffer.
class ITexture : public virtual IReferenceCounted
{
public:
//! constructor
ITexture(const io::path& name, E_TEXTURE_TYPE type) : NamedPath(name), DriverType(EDT_NULL), OriginalColorFormat(ECF_UNKNOWN),
ITexture(const io::path &name, E_TEXTURE_TYPE type) :
NamedPath(name), DriverType(EDT_NULL), OriginalColorFormat(ECF_UNKNOWN),
ColorFormat(ECF_UNKNOWN), Pitch(0), HasMipMaps(false), IsRenderTarget(false), Source(ETS_UNKNOWN), Type(type)
{
}
@ -206,7 +205,7 @@ public:
\return Returns a pointer to the pixel data. The format of the pixel can
be determined by using getColorFormat(). 0 is returned, if
the texture cannot be locked. */
virtual void* lock(E_TEXTURE_LOCK_MODE mode = ETLM_READ_WRITE, u32 mipmapLevel=0, u32 layer = 0, E_TEXTURE_LOCK_FLAGS lockFlags = ETLF_FLIP_Y_UP_RTT) = 0;
virtual void *lock(E_TEXTURE_LOCK_MODE mode = ETLM_READ_WRITE, u32 mipmapLevel = 0, u32 layer = 0, E_TEXTURE_LOCK_FLAGS lockFlags = ETLF_FLIP_Y_UP_RTT) = 0;
//! Unlock function. Must be called after a lock() to the texture.
/** One should avoid to call unlock more than once before another lock.
@ -223,7 +222,7 @@ public:
level. At least one pixel will be always kept.
\param layer It informs a texture about which cubemap or texture array layer
needs mipmap regeneration. */
virtual void regenerateMipMapLevels(void* data = 0, u32 layer = 0) = 0;
virtual void regenerateMipMapLevels(void *data = 0, u32 layer = 0) = 0;
//! Get original size of the texture.
/** The texture is usually scaled, if it was created with an unoptimal
@ -233,11 +232,11 @@ public:
exact size of the original texture. Use ITexture::getSize() if you want
to know the real size it has now stored in the system.
\return The original size of the texture. */
const core::dimension2d<u32>& getOriginalSize() const { return OriginalSize; };
const core::dimension2d<u32> &getOriginalSize() const { return OriginalSize; };
//! Get dimension (=size) of the texture.
/** \return The size of the texture. */
const core::dimension2d<u32>& getSize() const { return Size; };
const core::dimension2d<u32> &getSize() const { return Size; };
//! Get driver type of texture.
/** This is the driver, which created the texture. This method is used
@ -274,7 +273,7 @@ public:
bool isRenderTarget() const { return IsRenderTarget; }
//! Get name of texture (in most cases this is the filename)
const io::SNamedPath& getName() const { return NamedPath; }
const io::SNamedPath &getName() const { return NamedPath; }
//! Check where the last IVideoDriver::getTexture found this texture
E_TEXTURE_SOURCE getSource() const { return Source; }
@ -287,8 +286,7 @@ public:
{
bool status = false;
switch (ColorFormat)
{
switch (ColorFormat) {
case ECF_A8R8G8B8:
case ECF_A1R5G5B5:
case ECF_A16B16G16R16F:
@ -306,7 +304,6 @@ public:
E_TEXTURE_TYPE getType() const { return Type; }
protected:
//! Helper function, helps to get the desired texture creation format from the flags.
/** \return Either ETCF_ALWAYS_32_BIT, ETCF_ALWAYS_16_BIT,
ETCF_OPTIMIZED_FOR_QUALITY, or ETCF_OPTIMIZED_FOR_SPEED. */
@ -336,6 +333,5 @@ protected:
E_TEXTURE_TYPE Type;
};
} // end namespace video
} // end namespace irr

39
include/IVertexBuffer.h
View File

@ -14,36 +14,35 @@ namespace irr
namespace scene
{
class IVertexBuffer : public virtual IReferenceCounted
{
public:
virtual void* getData() =0;
virtual video::E_VERTEX_TYPE getType() const =0;
virtual void setType(video::E_VERTEX_TYPE vertexType) =0;
virtual u32 stride() const =0;
virtual u32 size() const =0;
virtual void push_back(const video::S3DVertex &element) =0;
virtual video::S3DVertex& operator [](const u32 index) const =0;
virtual video::S3DVertex& getLast() =0;
virtual void set_used(u32 usedNow) =0;
virtual void reallocate(u32 new_size) =0;
virtual u32 allocated_size() const =0;
virtual video::S3DVertex* pointer() =0;
class IVertexBuffer : public virtual IReferenceCounted
{
public:
virtual void *getData() = 0;
virtual video::E_VERTEX_TYPE getType() const = 0;
virtual void setType(video::E_VERTEX_TYPE vertexType) = 0;
virtual u32 stride() const = 0;
virtual u32 size() const = 0;
virtual void push_back(const video::S3DVertex &element) = 0;
virtual video::S3DVertex &operator[](const u32 index) const = 0;
virtual video::S3DVertex &getLast() = 0;
virtual void set_used(u32 usedNow) = 0;
virtual void reallocate(u32 new_size) = 0;
virtual u32 allocated_size() const = 0;
virtual video::S3DVertex *pointer() = 0;
//! get the current hardware mapping hint
virtual E_HARDWARE_MAPPING getHardwareMappingHint() const =0;
virtual E_HARDWARE_MAPPING getHardwareMappingHint() const = 0;
//! set the hardware mapping hint, for driver
virtual void setHardwareMappingHint( E_HARDWARE_MAPPING NewMappingHint ) =0;
virtual void setHardwareMappingHint(E_HARDWARE_MAPPING NewMappingHint) = 0;
//! flags the meshbuffer as changed, reloads hardware buffers
virtual void setDirty() =0;
virtual void setDirty() = 0;
//! Get the currently used ID for identification of changes.
/** This shouldn't be used for anything outside the VideoDriver. */
virtual u32 getChangedID() const = 0;
};
};
} // end namespace scene
} // end namespace irr

412
include/IVideoDriver.h
View File

@ -22,32 +22,32 @@ namespace irr
{
namespace io
{
class IAttributes;
class IReadFile;
class IWriteFile;
class IAttributes;
class IReadFile;
class IWriteFile;
} // end namespace io
namespace scene
{
class IMeshBuffer;
class IMesh;
class IMeshManipulator;
class ISceneNode;
class IMeshBuffer;
class IMesh;
class IMeshManipulator;
class ISceneNode;
} // end namespace scene
namespace video
{
struct S3DVertex;
struct S3DVertex2TCoords;
struct S3DVertexTangents;
class IImageLoader;
class IImageWriter;
class IMaterialRenderer;
class IGPUProgrammingServices;
class IRenderTarget;
struct S3DVertex;
struct S3DVertex2TCoords;
struct S3DVertexTangents;
class IImageLoader;
class IImageWriter;
class IMaterialRenderer;
class IGPUProgrammingServices;
class IRenderTarget;
//! enumeration for geometry transformation states
enum E_TRANSFORMATION_STATE
{
//! enumeration for geometry transformation states
enum E_TRANSFORMATION_STATE
{
//! View transformation
ETS_VIEW = 0,
//! World transformation
@ -59,14 +59,14 @@ namespace video
ETS_TEXTURE_0,
//! Only used internally
ETS_COUNT = ETS_TEXTURE_0 + MATERIAL_MAX_TEXTURES
};
};
//! Special render targets, which usually map to dedicated hardware
/** These render targets (besides 0 and 1) need not be supported by gfx cards */
enum E_RENDER_TARGET
{
//! Special render targets, which usually map to dedicated hardware
/** These render targets (besides 0 and 1) need not be supported by gfx cards */
enum E_RENDER_TARGET
{
//! Render target is the main color frame buffer
ERT_FRAME_BUFFER=0,
ERT_FRAME_BUFFER = 0,
//! Render target is a render texture
ERT_RENDER_TEXTURE,
//! Multi-Render target textures
@ -87,46 +87,44 @@ namespace video
ERT_AUX_BUFFER3,
//! Auxiliary buffer 4
ERT_AUX_BUFFER4
};
};
//! Enum for the flags of clear buffer
enum E_CLEAR_BUFFER_FLAG
{
//! Enum for the flags of clear buffer
enum E_CLEAR_BUFFER_FLAG
{
ECBF_NONE = 0,
ECBF_COLOR = 1,
ECBF_DEPTH = 2,
ECBF_STENCIL = 4,
ECBF_ALL = ECBF_COLOR|ECBF_DEPTH|ECBF_STENCIL
};
ECBF_ALL = ECBF_COLOR | ECBF_DEPTH | ECBF_STENCIL
};
//! Enum for the types of fog distributions to choose from
enum E_FOG_TYPE
{
EFT_FOG_EXP=0,
//! Enum for the types of fog distributions to choose from
enum E_FOG_TYPE
{
EFT_FOG_EXP = 0,
EFT_FOG_LINEAR,
EFT_FOG_EXP2
};
};
const c8* const FogTypeNames[] =
const c8 *const FogTypeNames[] =
{
"FogExp",
"FogLinear",
"FogExp2",
0
};
//! Interface to driver which is able to perform 2d and 3d graphics functions.
/** This interface is one of the most important interfaces of
the Irrlicht Engine: All rendering and texture manipulation is done with
this interface. You are able to use the Irrlicht Engine by only
invoking methods of this interface if you like to, although the
irr::scene::ISceneManager interface provides a lot of powerful classes
and methods to make the programmer's life easier.
*/
class IVideoDriver : public virtual IReferenceCounted
{
public:
0};
//! Interface to driver which is able to perform 2d and 3d graphics functions.
/** This interface is one of the most important interfaces of
the Irrlicht Engine: All rendering and texture manipulation is done with
this interface. You are able to use the Irrlicht Engine by only
invoking methods of this interface if you like to, although the
irr::scene::ISceneManager interface provides a lot of powerful classes
and methods to make the programmer's life easier.
*/
class IVideoDriver : public virtual IReferenceCounted
{
public:
//! Applications must call this method before performing any rendering.
/** This method can clear the back- and the z-buffer.
\param clearFlag A combination of the E_CLEAR_BUFFER_FLAG bit-flags.
@ -141,12 +139,12 @@ namespace video
rectangle of the area to be presented. Set to null to present
everything. Note: not implemented in all devices.
\return False if failed. */
virtual bool beginScene(u16 clearFlag=(u16)(ECBF_COLOR|ECBF_DEPTH), SColor clearColor = SColor(255,0,0,0), f32 clearDepth = 1.f, u8 clearStencil = 0,
const SExposedVideoData& videoData=SExposedVideoData(), core::rect<s32>* sourceRect = 0) = 0;
virtual bool beginScene(u16 clearFlag = (u16)(ECBF_COLOR | ECBF_DEPTH), SColor clearColor = SColor(255, 0, 0, 0), f32 clearDepth = 1.f, u8 clearStencil = 0,
const SExposedVideoData &videoData = SExposedVideoData(), core::rect<s32> *sourceRect = 0) = 0;
//! Alternative beginScene implementation. Can't clear stencil buffer, but otherwise identical to other beginScene
bool beginScene(bool backBuffer, bool zBuffer, SColor color = SColor(255,0,0,0),
const SExposedVideoData& videoData = SExposedVideoData(), core::rect<s32>* sourceRect = 0)
bool beginScene(bool backBuffer, bool zBuffer, SColor color = SColor(255, 0, 0, 0),
const SExposedVideoData &videoData = SExposedVideoData(), core::rect<s32> *sourceRect = 0)
{
u16 flag = 0;
@ -169,14 +167,14 @@ namespace video
/** Returns true if a feature is available
\param feature Feature to query.
\return True if the feature is available, false if not. */
virtual bool queryFeature(E_VIDEO_DRIVER_FEATURE feature) const =0;
virtual bool queryFeature(E_VIDEO_DRIVER_FEATURE feature) const = 0;
//! Disable a feature of the driver.
/** Can also be used to enable the features again. It is not
possible to enable unsupported features this way, though.
\param feature Feature to disable.
\param flag When true the feature is disabled, otherwise it is enabled. */
virtual void disableFeature(E_VIDEO_DRIVER_FEATURE feature, bool flag=true) =0;
virtual void disableFeature(E_VIDEO_DRIVER_FEATURE feature, bool flag = true) = 0;
//! Get attributes of the actual video driver
/** The following names can be queried for the given types:
@ -195,24 +193,24 @@ namespace video
ShaderLanguageVersion (int) Version of the high level shader language. Should be Major*100+Minor.
AntiAlias (int) Number of Samples the driver uses for each pixel. 0 and 1 means anti aliasing is off, typical values are 2,4,8,16,32
*/
virtual const io::IAttributes& getDriverAttributes() const=0;
virtual const io::IAttributes &getDriverAttributes() const = 0;
//! Check if the driver was recently reset.
/** For d3d devices you will need to recreate the RTTs if the
driver was reset. Should be queried right after beginScene().
*/
virtual bool checkDriverReset() =0;
virtual bool checkDriverReset() = 0;
//! Sets transformation matrices.
/** \param state Transformation type to be set, e.g. view,
world, or projection.
\param mat Matrix describing the transformation. */
virtual void setTransform(E_TRANSFORMATION_STATE state, const core::matrix4& mat) =0;
virtual void setTransform(E_TRANSFORMATION_STATE state, const core::matrix4 &mat) = 0;
//! Returns the transformation set by setTransform
/** \param state Transformation type to query
\return Matrix describing the transformation. */
virtual const core::matrix4& getTransform(E_TRANSFORMATION_STATE state) const =0;
virtual const core::matrix4 &getTransform(E_TRANSFORMATION_STATE state) const = 0;
//! Retrieve the number of image loaders
/** \return Number of image loaders */
@ -222,7 +220,7 @@ namespace video
/** \param n The index of the loader to retrieve. This parameter is an 0-based
array index.
\return A pointer to the specified loader, 0 if the index is incorrect. */
virtual IImageLoader* getImageLoader(u32 n) = 0;
virtual IImageLoader *getImageLoader(u32 n) = 0;
//! Retrieve the number of image writers
/** \return Number of image writers */
@ -232,12 +230,12 @@ namespace video
/** \param n The index of the writer to retrieve. This parameter is an 0-based
array index.
\return A pointer to the specified writer, 0 if the index is incorrect. */
virtual IImageWriter* getImageWriter(u32 n) = 0;
virtual IImageWriter *getImageWriter(u32 n) = 0;
//! Sets a material.
/** All 3d drawing functions will draw geometry using this material thereafter.
\param material: Material to be used from now on. */
virtual void setMaterial(const SMaterial& material) =0;
virtual void setMaterial(const SMaterial &material) = 0;
//! Get access to a named texture.
/** Loads the texture from disk if it is not
@ -249,7 +247,7 @@ namespace video
\return Pointer to the texture, or 0 if the texture
could not be loaded. This pointer should not be dropped. See
IReferenceCounted::drop() for more information. */
virtual ITexture* getTexture(const io::path& filename) = 0;
virtual ITexture *getTexture(const io::path &filename) = 0;
//! Get access to a named texture.
/** Loads the texture from disk if it is not
@ -261,7 +259,7 @@ namespace video
\return Pointer to the texture, or 0 if the texture
could not be loaded. This pointer should not be dropped. See
IReferenceCounted::drop() for more information. */
virtual ITexture* getTexture(io::IReadFile* file) =0;
virtual ITexture *getTexture(io::IReadFile *file) = 0;
//! Returns amount of textures currently loaded
/** \return Amount of textures currently loaded */
@ -278,8 +276,8 @@ namespace video
\return Pointer to the newly created texture. This pointer
should not be dropped. See IReferenceCounted::drop() for more
information. */
virtual ITexture* addTexture(const core::dimension2d<u32>& size,
const io::path& name, ECOLOR_FORMAT format = ECF_A8R8G8B8) = 0;
virtual ITexture *addTexture(const core::dimension2d<u32> &size,
const io::path &name, ECOLOR_FORMAT format = ECF_A8R8G8B8) = 0;
//! Creates a texture from an IImage.
/** \param name A name for the texture. Later calls of
@ -289,7 +287,7 @@ namespace video
\return Pointer to the newly created texture. This pointer
should not be dropped. See IReferenceCounted::drop() for more
information. */
virtual ITexture* addTexture(const io::path& name, IImage* image) = 0;
virtual ITexture *addTexture(const io::path &name, IImage *image) = 0;
//! Creates a cubemap texture from loaded IImages.
/** \param name A name for the texture. Later calls of getTexture() with this name will return this texture.
@ -301,8 +299,8 @@ namespace video
\param imagePosZ Image (positive Z) the texture is created from.
\param imageNegZ Image (negative Z) the texture is created from.
\return Pointer to the newly created texture. This pointer should not be dropped. See IReferenceCounted::drop() for more information. */
virtual ITexture* addTextureCubemap(const io::path& name, IImage* imagePosX, IImage* imageNegX, IImage* imagePosY,
IImage* imageNegY, IImage* imagePosZ, IImage* imageNegZ) = 0;
virtual ITexture *addTextureCubemap(const io::path &name, IImage *imagePosX, IImage *imageNegX, IImage *imagePosY,
IImage *imageNegY, IImage *imagePosZ, IImage *imageNegZ) = 0;
//! Creates an empty cubemap texture of specified size.
/** \param sideLen diameter of one side of the cube
@ -313,7 +311,7 @@ namespace video
that the driver may choose to create the texture in another
color format.
\return Pointer to the newly created texture. */
virtual ITexture* addTextureCubemap(const irr::u32 sideLen, const io::path& name, ECOLOR_FORMAT format = ECF_A8R8G8B8) = 0;
virtual ITexture *addTextureCubemap(const irr::u32 sideLen, const io::path &name, ECOLOR_FORMAT format = ECF_A8R8G8B8) = 0;
//! Adds a new render target texture to the texture cache.
/** \param size Size of the texture, in pixels. Width and
@ -328,8 +326,8 @@ namespace video
IReferenceCounted::drop() for more information.
You may want to remove it from driver texture cache with removeTexture if you no longer need it.
*/
virtual ITexture* addRenderTargetTexture(const core::dimension2d<u32>& size,
const io::path& name = "rt", const ECOLOR_FORMAT format = ECF_UNKNOWN) =0;
virtual ITexture *addRenderTargetTexture(const core::dimension2d<u32> &size,
const io::path &name = "rt", const ECOLOR_FORMAT format = ECF_UNKNOWN) = 0;
//! Adds a new render target texture with 6 sides for a cubemap map to the texture cache.
/** \param sideLen Length of one cubemap side.
@ -339,8 +337,8 @@ namespace video
\return Pointer to the created texture or 0 if the texture
could not be created. This pointer should not be dropped. See
IReferenceCounted::drop() for more information. */
virtual ITexture* addRenderTargetTextureCubemap(const irr::u32 sideLen,
const io::path& name = "rt", const ECOLOR_FORMAT format = ECF_UNKNOWN) =0;
virtual ITexture *addRenderTargetTextureCubemap(const irr::u32 sideLen,
const io::path &name = "rt", const ECOLOR_FORMAT format = ECF_UNKNOWN) = 0;
//! Removes a texture from the texture cache and deletes it.
/** This method can free a lot of memory!
@ -350,7 +348,7 @@ namespace video
good idea to set all materials which are using this texture to
0 or another texture first.
\param texture Texture to delete from the engine cache. */
virtual void removeTexture(ITexture* texture) =0;
virtual void removeTexture(ITexture *texture) = 0;
//! Removes all textures from the texture cache and deletes them.
/** This method can free a lot of memory!
@ -359,56 +357,56 @@ namespace video
by other parts of the engine for storing it longer. So it is a
good idea to set all materials which are using this texture to
0 or another texture first. */
virtual void removeAllTextures() =0;
virtual void removeAllTextures() = 0;
//! Remove hardware buffer
virtual void removeHardwareBuffer(const scene::IMeshBuffer* mb) =0;
virtual void removeHardwareBuffer(const scene::IMeshBuffer *mb) = 0;
//! Remove all hardware buffers
virtual void removeAllHardwareBuffers() =0;
virtual void removeAllHardwareBuffers() = 0;
//! Create occlusion query.
/** Use node for identification and mesh for occlusion test. */
virtual void addOcclusionQuery(scene::ISceneNode* node,
const scene::IMesh* mesh=0) =0;
virtual void addOcclusionQuery(scene::ISceneNode *node,
const scene::IMesh *mesh = 0) = 0;
//! Remove occlusion query.
virtual void removeOcclusionQuery(scene::ISceneNode* node) =0;
virtual void removeOcclusionQuery(scene::ISceneNode *node) = 0;
//! Remove all occlusion queries.
virtual void removeAllOcclusionQueries() =0;
virtual void removeAllOcclusionQueries() = 0;
//! Run occlusion query. Draws mesh stored in query.
/** If the mesh shall not be rendered visible, use
overrideMaterial to disable the color and depth buffer. */
virtual void runOcclusionQuery(scene::ISceneNode* node, bool visible=false) =0;
virtual void runOcclusionQuery(scene::ISceneNode *node, bool visible = false) = 0;
//! Run all occlusion queries. Draws all meshes stored in queries.
/** If the meshes shall not be rendered visible, use
overrideMaterial to disable the color and depth buffer. */
virtual void runAllOcclusionQueries(bool visible=false) =0;
virtual void runAllOcclusionQueries(bool visible = false) = 0;
//! Update occlusion query. Retrieves results from GPU.
/** If the query shall not block, set the flag to false.
Update might not occur in this case, though */
virtual void updateOcclusionQuery(scene::ISceneNode* node, bool block=true) =0;
virtual void updateOcclusionQuery(scene::ISceneNode *node, bool block = true) = 0;
//! Update all occlusion queries. Retrieves results from GPU.
/** If the query shall not block, set the flag to false.
Update might not occur in this case, though */
virtual void updateAllOcclusionQueries(bool block=true) =0;
virtual void updateAllOcclusionQueries(bool block = true) = 0;
//! Return query result.
/** Return value is the number of visible pixels/fragments.
The value is a safe approximation, i.e. can be larger than the
actual value of pixels. */
virtual u32 getOcclusionQueryResult(scene::ISceneNode* node) const =0;
virtual u32 getOcclusionQueryResult(scene::ISceneNode *node) const = 0;
//! Create render target.
virtual IRenderTarget* addRenderTarget() = 0;
virtual IRenderTarget *addRenderTarget() = 0;
//! Remove render target.
virtual void removeRenderTarget(IRenderTarget* renderTarget) = 0;
virtual void removeRenderTarget(IRenderTarget *renderTarget) = 0;
//! Remove all render targets.
virtual void removeAllRenderTargets() = 0;
@ -425,8 +423,8 @@ namespace video
example in picture edit programs. To avoid this problem, you
could use the makeColorKeyTexture method, which takes the
position of a pixel instead a color value. */
virtual void makeColorKeyTexture(video::ITexture* texture,
video::SColor color) const =0;
virtual void makeColorKeyTexture(video::ITexture *texture,
video::SColor color) const = 0;
//! Sets a boolean alpha channel on the texture based on the color at a position.
/** This makes the texture fully transparent at the texels where
@ -436,8 +434,8 @@ namespace video
\param colorKeyPixelPos Position of a pixel with the color key
color. Every texel with this color will become fully transparent as
described above. */
virtual void makeColorKeyTexture(video::ITexture* texture,
core::position2d<s32> colorKeyPixelPos) const =0;
virtual void makeColorKeyTexture(video::ITexture *texture,
core::position2d<s32> colorKeyPixelPos) const = 0;
//! Set a render target.
/** This will only work if the driver supports the
@ -455,7 +453,7 @@ namespace video
\param clearDepth The clear value for the depth buffer.
\param clearStencil The clear value for the stencil buffer.
\return True if successful and false if not. */
virtual bool setRenderTargetEx(IRenderTarget* target, u16 clearFlag, SColor clearColor = SColor(255,0,0,0),
virtual bool setRenderTargetEx(IRenderTarget *target, u16 clearFlag, SColor clearColor = SColor(255, 0, 0, 0),
f32 clearDepth = 1.f, u8 clearStencil = 0) = 0;
//! Sets a new render target.
@ -486,13 +484,13 @@ namespace video
\param clearDepth The clear value for the depth buffer.
\param clearStencil The clear value for the stencil buffer.
\return True if successful and false if not. */
virtual bool setRenderTarget(ITexture* texture, u16 clearFlag=ECBF_COLOR|ECBF_DEPTH, SColor clearColor = SColor(255,0,0,0),
virtual bool setRenderTarget(ITexture *texture, u16 clearFlag = ECBF_COLOR | ECBF_DEPTH, SColor clearColor = SColor(255, 0, 0, 0),
f32 clearDepth = 1.f, u8 clearStencil = 0) = 0;
//! Sets a new render target.
//! Prefer to use the setRenderTarget function taking flags as parameter as this one can't clear the stencil buffer.
//! It's still offered for backward compatibility.
bool setRenderTarget(ITexture* texture, bool clearBackBuffer, bool clearZBuffer, SColor color = SColor(255,0,0,0))
bool setRenderTarget(ITexture *texture, bool clearBackBuffer, bool clearZBuffer, SColor color = SColor(255, 0, 0, 0))
{
u16 flag = 0;
@ -509,11 +507,11 @@ namespace video
/** Every rendering operation is done into this new area.
\param area: Rectangle defining the new area of rendering
operations. */
virtual void setViewPort(const core::rect<s32>& area) =0;
virtual void setViewPort(const core::rect<s32> &area) = 0;
//! Gets the area of the current viewport.
/** \return Rectangle of the current viewport. */
virtual const core::rect<s32>& getViewPort() const =0;
virtual const core::rect<s32> &getViewPort() const = 0;
//! Draws a vertex primitive list
/** Note that, depending on the index type, some vertices might be not
@ -530,11 +528,11 @@ namespace video
\param vType Vertex type, e.g. video::EVT_STANDARD for S3DVertex.
\param pType Primitive type, e.g. scene::EPT_TRIANGLE_FAN for a triangle fan.
\param iType Index type, e.g. video::EIT_16BIT for 16bit indices. */
virtual void drawVertexPrimitiveList(const void* vertices, u32 vertexCount,
const void* indexList, u32 primCount,
E_VERTEX_TYPE vType=EVT_STANDARD,
scene::E_PRIMITIVE_TYPE pType=scene::EPT_TRIANGLES,
E_INDEX_TYPE iType=EIT_16BIT) =0;
virtual void drawVertexPrimitiveList(const void *vertices, u32 vertexCount,
const void *indexList, u32 primCount,
E_VERTEX_TYPE vType = EVT_STANDARD,
scene::E_PRIMITIVE_TYPE pType = scene::EPT_TRIANGLES,
E_INDEX_TYPE iType = EIT_16BIT) = 0;
//! Draws a vertex primitive list in 2d
/** Compared to the general (3d) version of this method, this
@ -556,11 +554,11 @@ namespace video
\param vType Vertex type, e.g. video::EVT_STANDARD for S3DVertex.
\param pType Primitive type, e.g. scene::EPT_TRIANGLE_FAN for a triangle fan.
\param iType Index type, e.g. video::EIT_16BIT for 16bit indices. */
virtual void draw2DVertexPrimitiveList(const void* vertices, u32 vertexCount,
const void* indexList, u32 primCount,
E_VERTEX_TYPE vType=EVT_STANDARD,
scene::E_PRIMITIVE_TYPE pType=scene::EPT_TRIANGLES,
E_INDEX_TYPE iType=EIT_16BIT) =0;
virtual void draw2DVertexPrimitiveList(const void *vertices, u32 vertexCount,
const void *indexList, u32 primCount,
E_VERTEX_TYPE vType = EVT_STANDARD,
scene::E_PRIMITIVE_TYPE pType = scene::EPT_TRIANGLES,
E_INDEX_TYPE iType = EIT_16BIT) = 0;
//! Draws an indexed triangle list.
/** Note that there may be at maximum 65536 vertices, because
@ -571,8 +569,8 @@ namespace video
\param vertexCount Amount of vertices in the array.
\param indexList Pointer to array of indices.
\param triangleCount Amount of Triangles. Usually amount of indices / 3. */
void drawIndexedTriangleList(const S3DVertex* vertices,
u32 vertexCount, const u16* indexList, u32 triangleCount)
void drawIndexedTriangleList(const S3DVertex *vertices,
u32 vertexCount, const u16 *indexList, u32 triangleCount)
{
drawVertexPrimitiveList(vertices, vertexCount, indexList, triangleCount, EVT_STANDARD, scene::EPT_TRIANGLES, EIT_16BIT);
}
@ -586,8 +584,8 @@ namespace video
\param vertexCount Amount of vertices in the array.
\param indexList Pointer to array of indices.
\param triangleCount Amount of Triangles. Usually amount of indices / 3. */
void drawIndexedTriangleList(const S3DVertex2TCoords* vertices,
u32 vertexCount, const u16* indexList, u32 triangleCount)
void drawIndexedTriangleList(const S3DVertex2TCoords *vertices,
u32 vertexCount, const u16 *indexList, u32 triangleCount)
{
drawVertexPrimitiveList(vertices, vertexCount, indexList, triangleCount, EVT_2TCOORDS, scene::EPT_TRIANGLES, EIT_16BIT);
}
@ -601,8 +599,8 @@ namespace video
\param vertexCount Amount of vertices in the array.
\param indexList Pointer to array of indices.
\param triangleCount Amount of Triangles. Usually amount of indices / 3. */
void drawIndexedTriangleList(const S3DVertexTangents* vertices,
u32 vertexCount, const u16* indexList, u32 triangleCount)
void drawIndexedTriangleList(const S3DVertexTangents *vertices,
u32 vertexCount, const u16 *indexList, u32 triangleCount)
{
drawVertexPrimitiveList(vertices, vertexCount, indexList, triangleCount, EVT_TANGENTS, scene::EPT_TRIANGLES, EIT_16BIT);
}
@ -616,8 +614,8 @@ namespace video
\param vertexCount Amount of vertices in the array.
\param indexList Pointer to array of indices.
\param triangleCount Amount of Triangles. Usually amount of indices - 2. */
void drawIndexedTriangleFan(const S3DVertex* vertices,
u32 vertexCount, const u16* indexList, u32 triangleCount)
void drawIndexedTriangleFan(const S3DVertex *vertices,
u32 vertexCount, const u16 *indexList, u32 triangleCount)
{
drawVertexPrimitiveList(vertices, vertexCount, indexList, triangleCount, EVT_STANDARD, scene::EPT_TRIANGLE_FAN, EIT_16BIT);
}
@ -631,8 +629,8 @@ namespace video
\param vertexCount Amount of vertices in the array.
\param indexList Pointer to array of indices.
\param triangleCount Amount of Triangles. Usually amount of indices - 2. */
void drawIndexedTriangleFan(const S3DVertex2TCoords* vertices,
u32 vertexCount, const u16* indexList, u32 triangleCount)
void drawIndexedTriangleFan(const S3DVertex2TCoords *vertices,
u32 vertexCount, const u16 *indexList, u32 triangleCount)
{
drawVertexPrimitiveList(vertices, vertexCount, indexList, triangleCount, EVT_2TCOORDS, scene::EPT_TRIANGLE_FAN, EIT_16BIT);
}
@ -646,8 +644,8 @@ namespace video
\param vertexCount Amount of vertices in the array.
\param indexList Pointer to array of indices.
\param triangleCount Amount of Triangles. Usually amount of indices - 2. */
void drawIndexedTriangleFan(const S3DVertexTangents* vertices,
u32 vertexCount, const u16* indexList, u32 triangleCount)
void drawIndexedTriangleFan(const S3DVertexTangents *vertices,
u32 vertexCount, const u16 *indexList, u32 triangleCount)
{
drawVertexPrimitiveList(vertices, vertexCount, indexList, triangleCount, EVT_TANGENTS, scene::EPT_TRIANGLE_FAN, EIT_16BIT);
}
@ -667,8 +665,8 @@ namespace video
\param start Start of the 3d line.
\param end End of the 3d line.
\param color Color of the line. */
virtual void draw3DLine(const core::vector3df& start,
const core::vector3df& end, SColor color = SColor(255,255,255,255)) =0;
virtual void draw3DLine(const core::vector3df &start,
const core::vector3df &end, SColor color = SColor(255, 255, 255, 255)) = 0;
//! Draws a 3d axis aligned box.
/** This method simply calls draw3DLine for the edges of the
@ -682,8 +680,8 @@ namespace video
for some properly set up material before drawing the box.
\param box The axis aligned box to draw
\param color Color to use while drawing the box. */
virtual void draw3DBox(const core::aabbox3d<f32>& box,
SColor color = SColor(255,255,255,255)) =0;
virtual void draw3DBox(const core::aabbox3d<f32> &box,
SColor color = SColor(255, 255, 255, 255)) = 0;
//! Draws a 2d image without any special effects
/** \param texture Pointer to texture to use.
@ -691,8 +689,8 @@ namespace video
image will be drawn.
\param useAlphaChannelOfTexture: If true, the alpha channel of
the texture is used to draw the image.*/
virtual void draw2DImage(const video::ITexture* texture,
const core::position2d<s32>& destPos, bool useAlphaChannelOfTexture=false) =0;
virtual void draw2DImage(const video::ITexture *texture,
const core::position2d<s32> &destPos, bool useAlphaChannelOfTexture = false) = 0;
//! Draws a 2d image using a color
/** (if color is other than
@ -710,9 +708,9 @@ namespace video
will be transparent.
\param useAlphaChannelOfTexture: If true, the alpha channel of
the texture is used to draw the image.*/
virtual void draw2DImage(const video::ITexture* texture, const core::position2d<s32>& destPos,
const core::rect<s32>& sourceRect, const core::rect<s32>* clipRect =0,
SColor color=SColor(255,255,255,255), bool useAlphaChannelOfTexture=false) =0;
virtual void draw2DImage(const video::ITexture *texture, const core::position2d<s32> &destPos,
const core::rect<s32> &sourceRect, const core::rect<s32> *clipRect = 0,
SColor color = SColor(255, 255, 255, 255), bool useAlphaChannelOfTexture = false) = 0;
//! Draws a set of 2d images, using a color and the alpha channel of the texture.
/** All drawings are clipped against clipRect (if != 0).
@ -730,12 +728,12 @@ namespace video
255, the image will be transparent.
\param useAlphaChannelOfTexture: If true, the alpha channel of
the texture is used to draw the image. */
virtual void draw2DImageBatch(const video::ITexture* texture,
const core::array<core::position2d<s32> >& positions,
const core::array<core::rect<s32> >& sourceRects,
const core::rect<s32>* clipRect=0,
SColor color=SColor(255,255,255,255),
bool useAlphaChannelOfTexture=false) =0;
virtual void draw2DImageBatch(const video::ITexture *texture,
const core::array<core::position2d<s32>> &positions,
const core::array<core::rect<s32>> &sourceRects,
const core::rect<s32> *clipRect = 0,
SColor color = SColor(255, 255, 255, 255),
bool useAlphaChannelOfTexture = false) = 0;
//! Draws a part of the texture into the rectangle. Note that colors must be an array of 4 colors if used.
/** Suggested and first implemented by zola.
@ -747,9 +745,9 @@ namespace video
the corners of the destRect
\param useAlphaChannelOfTexture True if alpha channel will be
blended. */
virtual void draw2DImage(const video::ITexture* texture, const core::rect<s32>& destRect,
const core::rect<s32>& sourceRect, const core::rect<s32>* clipRect =0,
const video::SColor * const colors=0, bool useAlphaChannelOfTexture=false) =0;
virtual void draw2DImage(const video::ITexture *texture, const core::rect<s32> &destRect,
const core::rect<s32> &sourceRect, const core::rect<s32> *clipRect = 0,
const video::SColor *const colors = 0, bool useAlphaChannelOfTexture = false) = 0;
//! Draws a 2d rectangle.
/** \param color Color of the rectangle to draw. The alpha
@ -759,8 +757,8 @@ namespace video
\param clip Pointer to rectangle against which the rectangle
will be clipped. If the pointer is null, no clipping will be
performed. */
virtual void draw2DRectangle(SColor color, const core::rect<s32>& pos,
const core::rect<s32>* clip =0) =0;
virtual void draw2DRectangle(SColor color, const core::rect<s32> &pos,
const core::rect<s32> *clip = 0) = 0;
//! Draws a 2d rectangle with a gradient.
/** \param colorLeftUp Color of the upper left corner to draw.
@ -779,10 +777,10 @@ namespace video
\param clip Pointer to rectangle against which the rectangle
will be clipped. If the pointer is null, no clipping will be
performed. */
virtual void draw2DRectangle(const core::rect<s32>& pos,
virtual void draw2DRectangle(const core::rect<s32> &pos,
SColor colorLeftUp, SColor colorRightUp,
SColor colorLeftDown, SColor colorRightDown,
const core::rect<s32>* clip =0) =0;
const core::rect<s32> *clip = 0) = 0;
//! Draws a 2d line.
/** In theory both start and end will be included in coloring.
@ -793,20 +791,20 @@ namespace video
\param end Screen coordinates of the start of the line in
pixels.
\param color Color of the line to draw. */
virtual void draw2DLine(const core::position2d<s32>& start,
const core::position2d<s32>& end,
SColor color=SColor(255,255,255,255)) =0;
virtual void draw2DLine(const core::position2d<s32> &start,
const core::position2d<s32> &end,
SColor color = SColor(255, 255, 255, 255)) = 0;
//! Draws a mesh buffer
/** \param mb Buffer to draw */
virtual void drawMeshBuffer(const scene::IMeshBuffer* mb) =0;
virtual void drawMeshBuffer(const scene::IMeshBuffer *mb) = 0;
//! Draws normals of a mesh buffer
/** \param mb Buffer to draw the normals of
\param length length scale factor of the normals
\param color Color the normals are rendered with
*/
virtual void drawMeshBufferNormals(const scene::IMeshBuffer* mb, f32 length=10.f, SColor color=0xffffffff) =0;
virtual void drawMeshBufferNormals(const scene::IMeshBuffer *mb, f32 length = 10.f, SColor color = 0xffffffff) = 0;
//! Sets the fog mode.
/** These are global values attached to each 3d object rendered,
@ -825,30 +823,30 @@ namespace video
fog. The distance from the viewer is used to compute the fog,
not the z-coordinate. This is better, but slower. This might not
be available with all drivers and fog settings. */
virtual void setFog(SColor color=SColor(0,255,255,255),
E_FOG_TYPE fogType=EFT_FOG_LINEAR,
f32 start=50.0f, f32 end=100.0f, f32 density=0.01f,
bool pixelFog=false, bool rangeFog=false) =0;
virtual void setFog(SColor color = SColor(0, 255, 255, 255),
E_FOG_TYPE fogType = EFT_FOG_LINEAR,
f32 start = 50.0f, f32 end = 100.0f, f32 density = 0.01f,
bool pixelFog = false, bool rangeFog = false) = 0;
//! Gets the fog mode.
virtual void getFog(SColor& color, E_FOG_TYPE& fogType,
f32& start, f32& end, f32& density,
bool& pixelFog, bool& rangeFog) = 0;
virtual void getFog(SColor &color, E_FOG_TYPE &fogType,
f32 &start, f32 &end, f32 &density,
bool &pixelFog, bool &rangeFog) = 0;
//! Get the current color format of the color buffer
/** \return Color format of the color buffer. */
virtual ECOLOR_FORMAT getColorFormat() const =0;
virtual ECOLOR_FORMAT getColorFormat() const = 0;
//! Get the size of the screen or render window.
/** \return Size of screen or render window. */
virtual const core::dimension2d<u32>& getScreenSize() const =0;
virtual const core::dimension2d<u32> &getScreenSize() const = 0;
//! Get the size of the current render target
/** This method will return the screen size if the driver
doesn't support render to texture, or if the current render
target is the screen.
\return Size of render target or screen/window */
virtual const core::dimension2d<u32>& getCurrentRenderTargetSize() const =0;
virtual const core::dimension2d<u32> &getCurrentRenderTargetSize() const = 0;
//! Returns current frames per second value.
/** This value is updated approximately every 1.5 seconds and
@ -856,19 +854,19 @@ namespace video
rate. It is not suitable for use in performing timing
calculations or framerate independent movement.
\return Approximate amount of frames per second drawn. */
virtual s32 getFPS() const =0;
virtual s32 getFPS() const = 0;
//! Returns amount of primitives (mostly triangles) which were drawn in the last frame.
/** Together with getFPS() very useful method for statistics.
\param mode Defines if the primitives drawn are accumulated or
counted per frame.
\return Amount of primitives drawn in the last frame. */
virtual u32 getPrimitiveCountDrawn( u32 mode =0 ) const =0;
virtual u32 getPrimitiveCountDrawn(u32 mode = 0) const = 0;
//! Gets name of this video driver.
/** \return Returns the name of the video driver, e.g. in case
of the Direct3D8 driver, it would return "Direct3D 8.1". */
virtual const char* getName() const =0;
virtual const char *getName() const = 0;
//! Adds an external image loader to the engine.
/** This is useful if the Irrlicht Engine should be able to load
@ -877,7 +875,7 @@ namespace video
format. A pointer to the implementation can be passed to the
engine using this method.
\param loader Pointer to the external loader created. */
virtual void addExternalImageLoader(IImageLoader* loader) =0;
virtual void addExternalImageLoader(IImageLoader *loader) = 0;
//! Adds an external image writer to the engine.
/** This is useful if the Irrlicht Engine should be able to
@ -886,13 +884,13 @@ namespace video
writing this file format. A pointer to the implementation can
be passed to the engine using this method.
\param writer: Pointer to the external writer created. */
virtual void addExternalImageWriter(IImageWriter* writer) =0;
virtual void addExternalImageWriter(IImageWriter *writer) = 0;
//! Returns the maximum amount of primitives
/** (mostly vertices) which the device is able to render with
one drawVertexPrimitiveList call.
\return Maximum amount of primitives. */
virtual u32 getMaximalPrimitiveCount() const =0;
virtual u32 getMaximalPrimitiveCount() const = 0;
//! Enables or disables a texture creation flag.
/** These flags define how textures should be created. By
@ -904,13 +902,13 @@ namespace video
\param flag Texture creation flag.
\param enabled Specifies if the given flag should be enabled or
disabled. */
virtual void setTextureCreationFlag(E_TEXTURE_CREATION_FLAG flag, bool enabled=true) =0;
virtual void setTextureCreationFlag(E_TEXTURE_CREATION_FLAG flag, bool enabled = true) = 0;
//! Returns if a texture creation flag is enabled or disabled.
/** You can change this value using setTextureCreationFlag().
\param flag Texture creation flag.
\return The current texture creation flag enabled mode. */
virtual bool getTextureCreationFlag(E_TEXTURE_CREATION_FLAG flag) const =0;
virtual bool getTextureCreationFlag(E_TEXTURE_CREATION_FLAG flag) const = 0;
//! Creates a software image from a file.
/** No hardware texture will be created for this image. This
@ -921,7 +919,7 @@ namespace video
\return The created image.
If you no longer need the image, you should call IImage::drop().
See IReferenceCounted::drop() for more information. */
virtual IImage* createImageFromFile(const io::path& filename) = 0;
virtual IImage *createImageFromFile(const io::path &filename) = 0;
//! Creates a software image from a file.
/** No hardware texture will be created for this image. This
@ -931,7 +929,7 @@ namespace video
\return The created image.
If you no longer need the image, you should call IImage::drop().
See IReferenceCounted::drop() for more information. */
virtual IImage* createImageFromFile(io::IReadFile* file) = 0;
virtual IImage *createImageFromFile(io::IReadFile *file) = 0;
//! Writes the provided image to a file.
/** Requires that there is a suitable image writer registered
@ -941,7 +939,7 @@ namespace video
\param param Control parameter for the backend (e.g. compression
level).
\return True on successful write. */
virtual bool writeImageToFile(IImage* image, const io::path& filename, u32 param = 0) = 0;
virtual bool writeImageToFile(IImage *image, const io::path &filename, u32 param = 0) = 0;
//! Writes the provided image to a file.
/** Requires that there is a suitable image writer registered
@ -952,7 +950,7 @@ namespace video
\param param Control parameter for the backend (e.g. compression
level).
\return True on successful write. */
virtual bool writeImageToFile(IImage* image, io::IWriteFile* file, u32 param =0) =0;
virtual bool writeImageToFile(IImage *image, io::IWriteFile *file, u32 param = 0) = 0;
//! Creates a software image from a byte array.
/** No hardware texture will be created for this image. This
@ -972,8 +970,8 @@ namespace video
\return The created image.
If you no longer need the image, you should call IImage::drop().
See IReferenceCounted::drop() for more information. */
virtual IImage* createImageFromData(ECOLOR_FORMAT format,
const core::dimension2d<u32>& size, void *data, bool ownForeignMemory = false,
virtual IImage *createImageFromData(ECOLOR_FORMAT format,
const core::dimension2d<u32> &size, void *data, bool ownForeignMemory = false,
bool deleteMemory = true) = 0;
//! Creates an empty software image.
@ -983,7 +981,7 @@ namespace video
\return The created image.
If you no longer need the image, you should call IImage::drop().
See IReferenceCounted::drop() for more information. */
virtual IImage* createImage(ECOLOR_FORMAT format, const core::dimension2d<u32>& size) =0;
virtual IImage *createImage(ECOLOR_FORMAT format, const core::dimension2d<u32> &size) = 0;
//! Creates a software image from a part of a texture.
/**
@ -993,14 +991,14 @@ namespace video
\return The created image.
If you no longer need the image, you should call IImage::drop().
See IReferenceCounted::drop() for more information. */
virtual IImage* createImage(ITexture* texture,
const core::position2d<s32>& pos,
const core::dimension2d<u32>& size) =0;
virtual IImage *createImage(ITexture *texture,
const core::position2d<s32> &pos,
const core::dimension2d<u32> &size) = 0;
//! Event handler for resize events. Only used by the engine internally.
/** Used to notify the driver that the window was resized.
Usually, there is no need to call this method. */
virtual void OnResize(const core::dimension2d<u32>& size) =0;
virtual void OnResize(const core::dimension2d<u32> &size) = 0;
//! Adds a new material renderer to the video device.
/** Use this method to extend the VideoDriver with new material
@ -1023,18 +1021,18 @@ namespace video
an error occurred. For example if you tried to add an material
renderer to the software renderer or the null device, which do
not accept material renderers. */
virtual s32 addMaterialRenderer(IMaterialRenderer* renderer, const c8* name =0) =0;
virtual s32 addMaterialRenderer(IMaterialRenderer *renderer, const c8 *name = 0) = 0;
//! Get access to a material renderer by index.
/** \param idx Id of the material renderer. Can be a value of
the E_MATERIAL_TYPE enum or a value which was returned by
addMaterialRenderer().
\return Pointer to material renderer or null if not existing. */
virtual IMaterialRenderer* getMaterialRenderer(u32 idx) const = 0;
virtual IMaterialRenderer *getMaterialRenderer(u32 idx) const = 0;
//! Get amount of currently available material renderers.
/** \return Amount of currently available material renderers. */
virtual u32 getMaterialRendererCount() const =0;
virtual u32 getMaterialRendererCount() const = 0;
//! Get name of a material renderer
/** This string can, e.g., be used to test if a specific
@ -1046,7 +1044,7 @@ namespace video
addMaterialRenderer().
\return String with the name of the renderer, or 0 if not
existing */
virtual const c8* getMaterialRendererName(u32 idx) const =0;
virtual const c8 *getMaterialRendererName(u32 idx) const = 0;
//! Sets the name of a material renderer.
/** Will have no effect on built-in material renderers.
@ -1054,7 +1052,7 @@ namespace video
E_MATERIAL_TYPE enum or a value which was returned by
addMaterialRenderer().
\param name: New name of the material renderer. */
virtual void setMaterialRendererName(u32 idx, const c8* name) =0;
virtual void setMaterialRendererName(u32 idx, const c8 *name) = 0;
//! Swap the material renderers used for certain id's
/** Swap the IMaterialRenderers responsible for rendering specific
@ -1064,29 +1062,29 @@ namespace video
\param idx2 Second material index to swap. It must already exist or nothing happens.
\param swapNames When true the renderer names also swap
When false the names will stay at the original index */
virtual void swapMaterialRenderers(u32 idx1, u32 idx2, bool swapNames=true) = 0;
virtual void swapMaterialRenderers(u32 idx1, u32 idx2, bool swapNames = true) = 0;
//! Returns driver and operating system specific data about the IVideoDriver.
/** This method should only be used if the engine should be
extended without having to modify the source of the engine.
\return Collection of device dependent pointers. */
virtual const SExposedVideoData& getExposedVideoData() =0;
virtual const SExposedVideoData &getExposedVideoData() = 0;
//! Get type of video driver
/** \return Type of driver. */
virtual E_DRIVER_TYPE getDriverType() const =0;
virtual E_DRIVER_TYPE getDriverType() const = 0;
//! Gets the IGPUProgrammingServices interface.
/** \return Pointer to the IGPUProgrammingServices. Returns 0
if the video driver does not support this. For example the
Software driver and the Null driver will always return 0. */
virtual IGPUProgrammingServices* getGPUProgrammingServices() =0;
virtual IGPUProgrammingServices *getGPUProgrammingServices() = 0;
//! Returns a pointer to the mesh manipulator.
virtual scene::IMeshManipulator* getMeshManipulator() =0;
virtual scene::IMeshManipulator *getMeshManipulator() = 0;
//! Clear the color, depth and/or stencil buffers.
virtual void clearBuffers(u16 flag, SColor color = SColor(255,0,0,0), f32 depth = 1.f, u8 stencil = 0) = 0;
virtual void clearBuffers(u16 flag, SColor color = SColor(255, 0, 0, 0), f32 depth = 1.f, u8 stencil = 0) = 0;
//! Clears the ZBuffer.
/** Note that you usually need not to call this method, as it
@ -1097,19 +1095,19 @@ namespace video
*/
void clearZBuffer()
{
clearBuffers(ECBF_DEPTH, SColor(255,0,0,0), 1.f, 0);
clearBuffers(ECBF_DEPTH, SColor(255, 0, 0, 0), 1.f, 0);
}
//! Make a screenshot of the last rendered frame.
/** \return An image created from the last rendered frame. */
virtual IImage* createScreenShot(video::ECOLOR_FORMAT format=video::ECF_UNKNOWN, video::E_RENDER_TARGET target=video::ERT_FRAME_BUFFER) =0;
virtual IImage *createScreenShot(video::ECOLOR_FORMAT format = video::ECF_UNKNOWN, video::E_RENDER_TARGET target = video::ERT_FRAME_BUFFER) = 0;
//! Check if the image is already loaded.
/** Works similar to getTexture(), but does not load the texture
if it is not currently loaded.
\param filename Name of the texture.
\return Pointer to loaded texture, or 0 if not found. */
virtual video::ITexture* findTexture(const io::path& filename) = 0;
virtual video::ITexture *findTexture(const io::path &filename) = 0;
//! Set or unset a clipping plane.
/** There are at least 6 clipping planes available for the user
@ -1120,7 +1118,7 @@ namespace video
\param enable If true, enable the clipping plane else disable
it.
\return True if the clipping plane is usable. */
virtual bool setClipPlane(u32 index, const core::plane3df& plane, bool enable=false) =0;
virtual bool setClipPlane(u32 index, const core::plane3df &plane, bool enable = false) = 0;
//! Enable or disable a clipping plane.
/** There are at least 6 clipping planes available for the user
@ -1129,18 +1127,18 @@ namespace video
MaxUserClipPlanes.
\param enable If true, enable the clipping plane else disable
it. */
virtual void enableClipPlane(u32 index, bool enable) =0;
virtual void enableClipPlane(u32 index, bool enable) = 0;
//! Set the minimum number of vertices for which a hw buffer will be created
/** \param count Number of vertices to set as minimum. */
virtual void setMinHardwareBufferVertexCount(u32 count) =0;
virtual void setMinHardwareBufferVertexCount(u32 count) = 0;
//! Get the global Material, which might override local materials.
/** Depending on the enable flags, values from this Material
are used to override those of local materials of some
meshbuffer being rendered.
\return Reference to the Override Material. */
virtual SOverrideMaterial& getOverrideMaterial() =0;
virtual SOverrideMaterial &getOverrideMaterial() = 0;
//! Get the 2d override material for altering its values
/** The 2d override material allows to alter certain render
@ -1156,33 +1154,33 @@ namespace video
\return Material reference which should be altered to reflect
the new settings.
*/
virtual SMaterial& getMaterial2D() =0;
virtual SMaterial &getMaterial2D() = 0;
//! Enable the 2d override material
/** \param enable Flag which tells whether the material shall be
enabled or disabled. */
virtual void enableMaterial2D(bool enable=true) =0;
virtual void enableMaterial2D(bool enable = true) = 0;
//! Get the graphics card vendor name.
virtual core::stringc getVendorInfo() =0;
virtual core::stringc getVendorInfo() = 0;
//! Only used by the engine internally.
/** The ambient color is set in the scene manager, see
scene::ISceneManager::setAmbientLight().
\param color New color of the ambient light. */
virtual void setAmbientLight(const SColorf& color) =0;
virtual void setAmbientLight(const SColorf &color) = 0;
//! Get the global ambient light currently used by the driver
virtual const SColorf& getAmbientLight() const = 0;
virtual const SColorf &getAmbientLight() const = 0;
//! Only used by the engine internally.
/** Passes the global material flag AllowZWriteOnTransparent.
Use the SceneManager attribute to set this value from your app.
\param flag Default behavior is to disable ZWrite, i.e. false. */
virtual void setAllowZWriteOnTransparent(bool flag) =0;
virtual void setAllowZWriteOnTransparent(bool flag) = 0;
//! Get the maximum texture size supported.
virtual core::dimension2du getMaxTextureSize() const =0;
virtual core::dimension2du getMaxTextureSize() const = 0;
//! Color conversion convenience function
/** Convert an image (as array of pixels) from source to destination
@ -1194,18 +1192,16 @@ namespace video
\param dP Pointer to destination
\param dF Color format of destination
*/
virtual void convertColor(const void* sP, ECOLOR_FORMAT sF, s32 sN,
void* dP, ECOLOR_FORMAT dF) const =0;
virtual void convertColor(const void *sP, ECOLOR_FORMAT sF, s32 sN,
void *dP, ECOLOR_FORMAT dF) const = 0;
//! Check if the driver supports creating textures with the given color format
/** \return True if the format is available, false if not. */
virtual bool queryTextureFormat(ECOLOR_FORMAT format) const = 0;
//! Used by some SceneNodes to check if a material should be rendered in the transparent render pass
virtual bool needsTransparentRenderPass(const irr::video::SMaterial& material) const = 0;
};
virtual bool needsTransparentRenderPass(const irr::video::SMaterial &material) const = 0;
};
} // end namespace video
} // end namespace irr

14
include/IWriteFile.h
View File

@ -12,15 +12,15 @@ namespace irr
namespace io
{
//! Interface providing write access to a file.
class IWriteFile : public virtual IReferenceCounted
{
public:
//! Interface providing write access to a file.
class IWriteFile : public virtual IReferenceCounted
{
public:
//! Writes an amount of bytes to the file.
/** \param buffer Pointer to buffer of bytes to write.
\param sizeToWrite Amount of bytes to write to the file.
\return How much bytes were written. */
virtual size_t write(const void* buffer, size_t sizeToWrite) = 0;
virtual size_t write(const void *buffer, size_t sizeToWrite) = 0;
//! Changes position in file
/** \param finalPos Destination position in the file.
@ -36,12 +36,12 @@ namespace io
//! Get name of file.
/** \return File name as zero terminated character string. */
virtual const path& getFileName() const = 0;
virtual const path &getFileName() const = 0;
//! Flush the content of the buffer in the file
/** \return True if successful, otherwise false. */
virtual bool flush() = 0;
};
};
} // end namespace io
} // end namespace irr

103
include/IrrlichtDevice.h
View File

@ -17,36 +17,39 @@
namespace irr
{
class ILogger;
class IEventReceiver;
class ILogger;
class IEventReceiver;
namespace io {
class IFileSystem;
} // end namespace io
namespace io
{
class IFileSystem;
} // end namespace io
namespace gui {
class IGUIEnvironment;
} // end namespace gui
namespace gui
{
class IGUIEnvironment;
} // end namespace gui
namespace scene {
class ISceneManager;
} // end namespace scene
namespace scene
{
class ISceneManager;
} // end namespace scene
namespace video {
class IContextManager;
extern "C" IRRLICHT_API bool IRRCALLCONV isDriverSupported(E_DRIVER_TYPE driver);
} // end namespace video
//! The Irrlicht device. You can create it with createDevice() or createDeviceEx().
/** This is the most important class of the Irrlicht Engine. You can
access everything in the engine if you have a pointer to an instance of
this class. There should be only one instance of this class at any
time.
*/
class IrrlichtDevice : public virtual IReferenceCounted
{
public:
namespace video
{
class IContextManager;
extern "C" IRRLICHT_API bool IRRCALLCONV isDriverSupported(E_DRIVER_TYPE driver);
} // end namespace video
//! The Irrlicht device. You can create it with createDevice() or createDeviceEx().
/** This is the most important class of the Irrlicht Engine. You can
access everything in the engine if you have a pointer to an instance of
this class. There should be only one instance of this class at any
time.
*/
class IrrlichtDevice : public virtual IReferenceCounted
{
public:
//! Runs the device.
/** Also increments the virtual timer by calling
ITimer::tick();. You can prevent this
@ -88,34 +91,34 @@ namespace irr
On most Linux systems it's relatively exact, but also no guarantee.
\param pauseTimer: If true, pauses the device timer while sleeping
*/
virtual void sleep(u32 timeMs, bool pauseTimer=false) = 0;
virtual void sleep(u32 timeMs, bool pauseTimer = false) = 0;
//! Provides access to the video driver for drawing 3d and 2d geometry.
/** \return Pointer the video driver. */
virtual video::IVideoDriver* getVideoDriver() = 0;
virtual video::IVideoDriver *getVideoDriver() = 0;
//! Provides access to the virtual file system.
/** \return Pointer to the file system. */
virtual io::IFileSystem* getFileSystem() = 0;
virtual io::IFileSystem *getFileSystem() = 0;
//! Provides access to the 2d user interface environment.
/** \return Pointer to the gui environment. */
virtual gui::IGUIEnvironment* getGUIEnvironment() = 0;
virtual gui::IGUIEnvironment *getGUIEnvironment() = 0;
//! Provides access to the scene manager.
/** \return Pointer to the scene manager. */
virtual scene::ISceneManager* getSceneManager() = 0;
virtual scene::ISceneManager *getSceneManager() = 0;
//! Provides access to the cursor control.
/** \return Pointer to the mouse cursor control interface. */
virtual gui::ICursorControl* getCursorControl() = 0;
virtual gui::ICursorControl *getCursorControl() = 0;
//! Provides access to the message logger.
/** \return Pointer to the logger. */
virtual ILogger* getLogger() = 0;
virtual ILogger *getLogger() = 0;
//! Get context manager
virtual video::IContextManager* getContextManager() = 0;
virtual video::IContextManager *getContextManager() = 0;
//! Provides access to the operation system operator object.
/** The OS operator provides methods for
@ -123,17 +126,17 @@ namespace irr
specific operations, such as exchanging data with the clipboard
or reading the operation system version.
\return Pointer to the OS operator. */
virtual IOSOperator* getOSOperator() = 0;
virtual IOSOperator *getOSOperator() = 0;
//! Provides access to the engine's timer.
/** The system time can be retrieved by it as
well as the virtual time, which also can be manipulated.
\return Pointer to the ITimer object. */
virtual ITimer* getTimer() = 0;
virtual ITimer *getTimer() = 0;
//! Sets the caption of the window.
/** \param text: New text of the window caption. */
virtual void setWindowCaption(const wchar_t* text) = 0;
virtual void setWindowCaption(const wchar_t *text) = 0;
//! Sets the window icon.
/** \param img The icon texture.
@ -195,18 +198,18 @@ namespace irr
/** The returned string
will look like this: "1.2.3" or this: "1.2".
\return String which contains the version. */
virtual const c8* getVersion() const = 0;
virtual const c8 *getVersion() const = 0;
//! Sets a new user event receiver which will receive events from the engine.
/** Return true in IEventReceiver::OnEvent to prevent the event from continuing along
the chain of event receivers. The path that an event takes through the system depends
on its type. See irr::EEVENT_TYPE for details.
\param receiver New receiver to be used. */
virtual void setEventReceiver(IEventReceiver* receiver) = 0;
virtual void setEventReceiver(IEventReceiver *receiver) = 0;
//! Provides access to the current event receiver.
/** \return Pointer to the current event receiver. Returns 0 if there is none. */
virtual IEventReceiver* getEventReceiver() = 0;
virtual IEventReceiver *getEventReceiver() = 0;
//! Sends a user created event to the engine.
/** Is is usually not necessary to use this. However, if you
@ -214,35 +217,35 @@ namespace irr
input, you can use this to post key or mouse input events to
the engine. Internally, this method only delegates the events
further to the scene manager and the GUI environment. */
virtual bool postEventFromUser(const SEvent& event) = 0;
virtual bool postEventFromUser(const SEvent &event) = 0;
//! Sets the input receiving scene manager.
/** If set to null, the main scene manager (returned by
GetSceneManager()) will receive the input
\param sceneManager New scene manager to be used. */
virtual void setInputReceivingSceneManager(scene::ISceneManager* sceneManager) = 0;
virtual void setInputReceivingSceneManager(scene::ISceneManager *sceneManager) = 0;
//! Sets if the window should be resizable in windowed mode.
/** The default is false. This method only works in windowed
mode.
\param resize Flag whether the window should be resizable. */
virtual void setResizable(bool resize=false) = 0;
virtual void setResizable(bool resize = false) = 0;
//! Resize the render window.
/** This will only work in windowed mode and is not yet supported on all systems.
It does set the drawing/clientDC size of the window, the window decorations are added to that.
You get the current window size with IVideoDriver::getScreenSize() (might be unified in future)
*/
virtual void setWindowSize(const irr::core::dimension2d<u32>& size) = 0;
virtual void setWindowSize(const irr::core::dimension2d<u32> &size) = 0;
//! Minimizes the window if possible.
virtual void minimizeWindow() =0;
virtual void minimizeWindow() = 0;
//! Maximizes the window if possible.
virtual void maximizeWindow() =0;
virtual void maximizeWindow() = 0;
//! Restore the window to normal size if possible.
virtual void restoreWindow() =0;
virtual void restoreWindow() = 0;
//! Get the position of the frame on-screen
virtual core::position2di getWindowPosition() = 0;
@ -255,7 +258,7 @@ namespace irr
\return true if joysticks are supported on this device, false if joysticks are not
supported or support is compiled out.
*/
virtual bool activateJoysticks(core::array<SJoystickInfo>& joystickInfo) =0;
virtual bool activateJoysticks(core::array<SJoystickInfo> &joystickInfo) = 0;
//! Activate accelerometer.
virtual bool activateAccelerometer(float updateInterval = 0.016666f) = 0;
@ -297,13 +300,13 @@ namespace irr
/** When set to 0 no double- and tripleclicks will be generated.
\param timeMs maximal time in milliseconds for two consecutive clicks to be recognized as double click
*/
virtual void setDoubleClickTime(u32 timeMs) =0;
virtual void setDoubleClickTime(u32 timeMs) = 0;
//! Get the maximal elapsed time between 2 clicks to generate double- and tripleclicks for the mouse.
/** When return value is 0 no double- and tripleclicks will be generated.
\return maximal time in milliseconds for two consecutive clicks to be recognized as double click
*/
virtual u32 getDoubleClickTime() const =0;
virtual u32 getDoubleClickTime() const = 0;
//! Remove messages pending in the system message loop
/** This function is usually used after messages have been buffered for a longer time, for example
@ -333,6 +336,6 @@ namespace irr
{
return video::isDriverSupported(driver);
}
};
};
} // end namespace irr

10
include/Keycodes.h
View File

@ -7,8 +7,8 @@
namespace irr
{
enum EKEY_CODE
{
enum EKEY_CODE
{
KEY_UNKNOWN = 0x0,
KEY_LBUTTON = 0x01, // Left mouse button
KEY_RBUTTON = 0x02, // Right mouse button
@ -146,7 +146,7 @@ namespace irr
KEY_BROWSER_REFRESH = 0xA8, // Browser Refresh key
KEY_BROWSER_STOP = 0xA9, // Browser Stop key
KEY_BROWSER_SEARCH = 0xAA, // Browser Search key
KEY_BROWSER_FAVORITES =0xAB, // Browser Favorites key
KEY_BROWSER_FAVORITES = 0xAB, // Browser Favorites key
KEY_BROWSER_HOME = 0xAC, // Browser Start and Home key
KEY_VOLUME_MUTE = 0xAD, // Volume Mute key
KEY_VOLUME_DOWN = 0xAE, // Volume Down key
@ -180,8 +180,6 @@ namespace irr
KEY_NONE = 0xFF, // usually no key mapping, but some laptops use it for fn key
KEY_KEY_CODES_COUNT = 0x100 // this is not a key, but the amount of keycodes there are.
};
};
} // end namespace irr

144
include/S3DVertex.h
View File

@ -31,28 +31,29 @@ enum E_VERTEX_TYPE
};
//! Array holding the built in vertex type names
const char* const sBuiltInVertexTypeNames[] =
{
const char *const sBuiltInVertexTypeNames[] =
{
"standard",
"2tcoords",
"tangents",
0
};
0};
//! standard vertex used by the Irrlicht engine.
struct S3DVertex
{
//! default constructor
constexpr S3DVertex() : Color(0xffffffff) {}
constexpr S3DVertex() :
Color(0xffffffff) {}
//! constructor
constexpr S3DVertex(f32 x, f32 y, f32 z, f32 nx, f32 ny, f32 nz, SColor c, f32 tu, f32 tv)
: Pos(x,y,z), Normal(nx,ny,nz), Color(c), TCoords(tu,tv) {}
constexpr S3DVertex(f32 x, f32 y, f32 z, f32 nx, f32 ny, f32 nz, SColor c, f32 tu, f32 tv) :
Pos(x, y, z), Normal(nx, ny, nz), Color(c), TCoords(tu, tv) {}
//! constructor
constexpr S3DVertex(const core::vector3df& pos, const core::vector3df& normal,
SColor color, const core::vector2df& tcoords)
: Pos(pos), Normal(normal), Color(color), TCoords(tcoords) {}
constexpr S3DVertex(const core::vector3df &pos, const core::vector3df &normal,
SColor color, const core::vector2df &tcoords) :
Pos(pos),
Normal(normal), Color(color), TCoords(tcoords) {}
//! Position
core::vector3df Pos;
@ -66,19 +67,19 @@ struct S3DVertex
//! Texture coordinates
core::vector2df TCoords;
constexpr bool operator==(const S3DVertex& other) const
constexpr bool operator==(const S3DVertex &other) const
{
return ((Pos == other.Pos) && (Normal == other.Normal) &&
(Color == other.Color) && (TCoords == other.TCoords));
}
constexpr bool operator!=(const S3DVertex& other) const
constexpr bool operator!=(const S3DVertex &other) const
{
return ((Pos != other.Pos) || (Normal != other.Normal) ||
(Color != other.Color) || (TCoords != other.TCoords));
}
constexpr bool operator<(const S3DVertex& other) const
constexpr bool operator<(const S3DVertex &other) const
{
return ((Pos < other.Pos) ||
((Pos == other.Pos) && (Normal < other.Normal)) ||
@ -93,7 +94,7 @@ struct S3DVertex
}
//\param d d=0 returns other, d=1 returns this, values between interpolate.
S3DVertex getInterpolated(const S3DVertex& other, f32 d)
S3DVertex getInterpolated(const S3DVertex &other, f32 d)
{
d = core::clamp(d, 0.0f, 1.0f);
return S3DVertex(Pos.getInterpolated(other.Pos, d),
@ -103,7 +104,6 @@ struct S3DVertex
}
};
//! Vertex with two texture coordinates.
/** Usually used for geometry with lightmaps
or other special materials.
@ -111,61 +111,68 @@ or other special materials.
struct S3DVertex2TCoords : public S3DVertex
{
//! default constructor
constexpr S3DVertex2TCoords() : S3DVertex() {}
constexpr S3DVertex2TCoords() :
S3DVertex() {}
//! constructor with two different texture coords, but no normal
constexpr S3DVertex2TCoords(f32 x, f32 y, f32 z, SColor c, f32 tu, f32 tv, f32 tu2, f32 tv2)
: S3DVertex(x,y,z, 0.0f, 0.0f, 0.0f, c, tu,tv), TCoords2(tu2,tv2) {}
constexpr S3DVertex2TCoords(f32 x, f32 y, f32 z, SColor c, f32 tu, f32 tv, f32 tu2, f32 tv2) :
S3DVertex(x, y, z, 0.0f, 0.0f, 0.0f, c, tu, tv), TCoords2(tu2, tv2) {}
//! constructor with two different texture coords, but no normal
constexpr S3DVertex2TCoords(const core::vector3df& pos, SColor color,
const core::vector2df& tcoords, const core::vector2df& tcoords2)
: S3DVertex(pos, core::vector3df(), color, tcoords), TCoords2(tcoords2) {}
constexpr S3DVertex2TCoords(const core::vector3df &pos, SColor color,
const core::vector2df &tcoords, const core::vector2df &tcoords2) :
S3DVertex(pos, core::vector3df(), color, tcoords),
TCoords2(tcoords2) {}
//! constructor with all values
constexpr S3DVertex2TCoords(const core::vector3df& pos, const core::vector3df& normal, const SColor& color,
const core::vector2df& tcoords, const core::vector2df& tcoords2)
: S3DVertex(pos, normal, color, tcoords), TCoords2(tcoords2) {}
constexpr S3DVertex2TCoords(const core::vector3df &pos, const core::vector3df &normal, const SColor &color,
const core::vector2df &tcoords, const core::vector2df &tcoords2) :
S3DVertex(pos, normal, color, tcoords),
TCoords2(tcoords2) {}
//! constructor with all values
constexpr S3DVertex2TCoords(f32 x, f32 y, f32 z, f32 nx, f32 ny, f32 nz,
SColor c, f32 tu, f32 tv, f32 tu2, f32 tv2)
: S3DVertex(x,y,z, nx,ny,nz, c, tu,tv), TCoords2(tu2,tv2) {}
SColor c, f32 tu, f32 tv, f32 tu2, f32 tv2) :
S3DVertex(x, y, z, nx, ny, nz, c, tu, tv),
TCoords2(tu2, tv2) {}
//! constructor with the same texture coords and normal
constexpr S3DVertex2TCoords(f32 x, f32 y, f32 z, f32 nx, f32 ny, f32 nz,
SColor c, f32 tu, f32 tv)
: S3DVertex(x,y,z, nx,ny,nz, c, tu,tv), TCoords2(tu,tv) {}
SColor c, f32 tu, f32 tv) :
S3DVertex(x, y, z, nx, ny, nz, c, tu, tv),
TCoords2(tu, tv) {}
//! constructor with the same texture coords and normal
constexpr S3DVertex2TCoords(const core::vector3df& pos, const core::vector3df& normal,
SColor color, const core::vector2df& tcoords)
: S3DVertex(pos, normal, color, tcoords), TCoords2(tcoords) {}
constexpr S3DVertex2TCoords(const core::vector3df &pos, const core::vector3df &normal,
SColor color, const core::vector2df &tcoords) :
S3DVertex(pos, normal, color, tcoords),
TCoords2(tcoords) {}
//! constructor from S3DVertex
constexpr S3DVertex2TCoords(const S3DVertex& o) : S3DVertex(o) {}
constexpr S3DVertex2TCoords(const S3DVertex &o) :
S3DVertex(o) {}
//! Second set of texture coordinates
core::vector2df TCoords2;
//! Equality operator
constexpr bool operator==(const S3DVertex2TCoords& other) const
constexpr bool operator==(const S3DVertex2TCoords &other) const
{
return ((static_cast<S3DVertex>(*this)==static_cast<const S3DVertex&>(other)) &&
return ((static_cast<S3DVertex>(*this) == static_cast<const S3DVertex &>(other)) &&
(TCoords2 == other.TCoords2));
}
//! Inequality operator
constexpr bool operator!=(const S3DVertex2TCoords& other) const
constexpr bool operator!=(const S3DVertex2TCoords &other) const
{
return ((static_cast<S3DVertex>(*this)!=static_cast<const S3DVertex&>(other)) ||
return ((static_cast<S3DVertex>(*this) != static_cast<const S3DVertex &>(other)) ||
(TCoords2 != other.TCoords2));
}
constexpr bool operator<(const S3DVertex2TCoords& other) const
constexpr bool operator<(const S3DVertex2TCoords &other) const
{
return ((static_cast<S3DVertex>(*this) < other) ||
((static_cast<S3DVertex>(*this) == static_cast<const S3DVertex&>(other)) && (TCoords2 < other.TCoords2)));
((static_cast<S3DVertex>(*this) == static_cast<const S3DVertex &>(other)) && (TCoords2 < other.TCoords2)));
}
static E_VERTEX_TYPE getType()
@ -174,7 +181,7 @@ struct S3DVertex2TCoords : public S3DVertex
}
//\param d d=0 returns other, d=1 returns this, values between interpolate.
S3DVertex2TCoords getInterpolated(const S3DVertex2TCoords& other, f32 d)
S3DVertex2TCoords getInterpolated(const S3DVertex2TCoords &other, f32 d)
{
d = core::clamp(d, 0.0f, 1.0f);
return S3DVertex2TCoords(Pos.getInterpolated(other.Pos, d),
@ -185,7 +192,6 @@ struct S3DVertex2TCoords : public S3DVertex
}
};
//! Vertex with a tangent and binormal vector.
/** Usually used for tangent space normal mapping.
Usually tangent and binormal get send to shaders as texture coordinate sets 1 and 2.
@ -193,30 +199,34 @@ struct S3DVertex2TCoords : public S3DVertex
struct S3DVertexTangents : public S3DVertex
{
//! default constructor
S3DVertexTangents() : S3DVertex() { }
S3DVertexTangents() :
S3DVertex() {}
//! constructor
constexpr S3DVertexTangents(f32 x, f32 y, f32 z, f32 nx=0.0f, f32 ny=0.0f, f32 nz=0.0f,
SColor c = 0xFFFFFFFF, f32 tu=0.0f, f32 tv=0.0f,
f32 tanx=0.0f, f32 tany=0.0f, f32 tanz=0.0f,
f32 bx=0.0f, f32 by=0.0f, f32 bz=0.0f)
: S3DVertex(x,y,z, nx,ny,nz, c, tu,tv), Tangent(tanx,tany,tanz), Binormal(bx,by,bz) { }
constexpr S3DVertexTangents(f32 x, f32 y, f32 z, f32 nx = 0.0f, f32 ny = 0.0f, f32 nz = 0.0f,
SColor c = 0xFFFFFFFF, f32 tu = 0.0f, f32 tv = 0.0f,
f32 tanx = 0.0f, f32 tany = 0.0f, f32 tanz = 0.0f,
f32 bx = 0.0f, f32 by = 0.0f, f32 bz = 0.0f) :
S3DVertex(x, y, z, nx, ny, nz, c, tu, tv),
Tangent(tanx, tany, tanz), Binormal(bx, by, bz) {}
//! constructor
constexpr S3DVertexTangents(const core::vector3df& pos, SColor c,
const core::vector2df& tcoords)
: S3DVertex(pos, core::vector3df(), c, tcoords) { }
constexpr S3DVertexTangents(const core::vector3df &pos, SColor c,
const core::vector2df &tcoords) :
S3DVertex(pos, core::vector3df(), c, tcoords) {}
//! constructor
constexpr S3DVertexTangents(const core::vector3df& pos,
const core::vector3df& normal, SColor c,
const core::vector2df& tcoords,
const core::vector3df& tangent=core::vector3df(),
const core::vector3df& binormal=core::vector3df())
: S3DVertex(pos, normal, c, tcoords), Tangent(tangent), Binormal(binormal) { }
constexpr S3DVertexTangents(const core::vector3df &pos,
const core::vector3df &normal, SColor c,
const core::vector2df &tcoords,
const core::vector3df &tangent = core::vector3df(),
const core::vector3df &binormal = core::vector3df()) :
S3DVertex(pos, normal, c, tcoords),
Tangent(tangent), Binormal(binormal) {}
//! constructor from S3DVertex
constexpr S3DVertexTangents(const S3DVertex& o) : S3DVertex(o) {}
constexpr S3DVertexTangents(const S3DVertex &o) :
S3DVertex(o) {}
//! Tangent vector along the x-axis of the texture
core::vector3df Tangent;
@ -224,25 +234,25 @@ struct S3DVertexTangents : public S3DVertex
//! Binormal vector (tangent x normal)
core::vector3df Binormal;
constexpr bool operator==(const S3DVertexTangents& other) const
constexpr bool operator==(const S3DVertexTangents &other) const
{
return ((static_cast<S3DVertex>(*this)==static_cast<const S3DVertex&>(other)) &&
return ((static_cast<S3DVertex>(*this) == static_cast<const S3DVertex &>(other)) &&
(Tangent == other.Tangent) &&
(Binormal == other.Binormal));
}
constexpr bool operator!=(const S3DVertexTangents& other) const
constexpr bool operator!=(const S3DVertexTangents &other) const
{
return ((static_cast<S3DVertex>(*this)!=static_cast<const S3DVertex&>(other)) ||
return ((static_cast<S3DVertex>(*this) != static_cast<const S3DVertex &>(other)) ||
(Tangent != other.Tangent) ||
(Binormal != other.Binormal));
}
constexpr bool operator<(const S3DVertexTangents& other) const
constexpr bool operator<(const S3DVertexTangents &other) const
{
return ((static_cast<S3DVertex>(*this) < other) ||
((static_cast<S3DVertex>(*this) == static_cast<const S3DVertex&>(other)) && (Tangent < other.Tangent)) ||
((static_cast<S3DVertex>(*this) == static_cast<const S3DVertex&>(other)) && (Tangent == other.Tangent) && (Binormal < other.Binormal)));
((static_cast<S3DVertex>(*this) == static_cast<const S3DVertex &>(other)) && (Tangent < other.Tangent)) ||
((static_cast<S3DVertex>(*this) == static_cast<const S3DVertex &>(other)) && (Tangent == other.Tangent) && (Binormal < other.Binormal)));
}
static E_VERTEX_TYPE getType()
@ -250,7 +260,7 @@ struct S3DVertexTangents : public S3DVertex
return EVT_TANGENTS;
}
S3DVertexTangents getInterpolated(const S3DVertexTangents& other, f32 d)
S3DVertexTangents getInterpolated(const S3DVertexTangents &other, f32 d)
{
d = core::clamp(d, 0.0f, 1.0f);
return S3DVertexTangents(Pos.getInterpolated(other.Pos, d),
@ -262,12 +272,9 @@ struct S3DVertexTangents : public S3DVertex
}
};
inline u32 getVertexPitchFromType(E_VERTEX_TYPE vertexType)
{
switch (vertexType)
{
switch (vertexType) {
case video::EVT_2TCOORDS:
return sizeof(video::S3DVertex2TCoords);
case video::EVT_TANGENTS:
@ -277,6 +284,5 @@ inline u32 getVertexPitchFromType(E_VERTEX_TYPE vertexType)
}
}
} // end namespace video
} // end namespace irr

49
include/SAnimatedMesh.h
View File

@ -14,15 +14,16 @@ namespace irr
namespace scene
{
//! Simple implementation of the IAnimatedMesh interface.
struct SAnimatedMesh : public IAnimatedMesh
{
//! Simple implementation of the IAnimatedMesh interface.
struct SAnimatedMesh : public IAnimatedMesh
{
//! constructor
SAnimatedMesh(scene::IMesh* mesh=0, scene::E_ANIMATED_MESH_TYPE type=scene::EAMT_UNKNOWN) : IAnimatedMesh(), FramesPerSecond(25.f), Type(type)
SAnimatedMesh(scene::IMesh *mesh = 0, scene::E_ANIMATED_MESH_TYPE type = scene::EAMT_UNKNOWN) :
IAnimatedMesh(), FramesPerSecond(25.f), Type(type)
{
#ifdef _DEBUG
#ifdef _DEBUG
setDebugName("SAnimatedMesh");
#endif
#endif
addMesh(mesh);
recalculateBoundingBox();
}
@ -31,7 +32,7 @@ namespace scene
virtual ~SAnimatedMesh()
{
// drop meshes
for (u32 i=0; i<Meshes.size(); ++i)
for (u32 i = 0; i < Meshes.size(); ++i)
Meshes[i]->drop();
}
@ -54,7 +55,7 @@ namespace scene
The actual speed is set in the scene node the mesh is instantiated in.*/
void setAnimationSpeed(f32 fps) override
{
FramesPerSecond=fps;
FramesPerSecond = fps;
}
//! Returns the IMesh interface for a frame.
@ -65,7 +66,7 @@ namespace scene
\param startFrameLoop: start frame
\param endFrameLoop: end frame
\return The animated mesh based on a detail level. */
IMesh* getMesh(s32 frame, s32 detailLevel=255, s32 startFrameLoop=-1, s32 endFrameLoop=-1) override
IMesh *getMesh(s32 frame, s32 detailLevel = 255, s32 startFrameLoop = -1, s32 endFrameLoop = -1) override
{
if (Meshes.empty())
return 0;
@ -74,10 +75,9 @@ namespace scene
}
//! adds a Mesh
void addMesh(IMesh* mesh)
{
if (mesh)
void addMesh(IMesh *mesh)
{
if (mesh) {
mesh->grab();
Meshes.push_back(mesh);
}
@ -85,13 +85,13 @@ namespace scene
//! Returns an axis aligned bounding box of the mesh.
/** \return A bounding box of this mesh is returned. */
const core::aabbox3d<f32>& getBoundingBox() const override
const core::aabbox3d<f32> &getBoundingBox() const override
{
return Box;
}
//! set user axis aligned bounding box
void setBoundingBox(const core::aabbox3df& box) override
void setBoundingBox(const core::aabbox3df &box) override
{
Box = box;
}
@ -99,14 +99,14 @@ namespace scene
//! Recalculates the bounding box.
void recalculateBoundingBox()
{
Box.reset(0,0,0);
Box.reset(0, 0, 0);
if (Meshes.empty())
return;
Box = Meshes[0]->getBoundingBox();
for (u32 i=1; i<Meshes.size(); ++i)
for (u32 i = 1; i < Meshes.size(); ++i)
Box.addInternalBox(Meshes[i]->getBoundingBox());
}
@ -126,7 +126,7 @@ namespace scene
}
//! returns pointer to a mesh buffer
IMeshBuffer* getMeshBuffer(u32 nr) const override
IMeshBuffer *getMeshBuffer(u32 nr) const override
{
if (Meshes.empty())
return 0;
@ -138,7 +138,7 @@ namespace scene
/** \param material: material to search for
\return Returns the pointer to the mesh buffer or
NULL if there is no such mesh buffer. */
IMeshBuffer* getMeshBuffer( const video::SMaterial &material) const override
IMeshBuffer *getMeshBuffer(const video::SMaterial &material) const override
{
if (Meshes.empty())
return 0;
@ -147,21 +147,21 @@ namespace scene
}
//! set the hardware mapping hint, for driver
void setHardwareMappingHint( E_HARDWARE_MAPPING newMappingHint, E_BUFFER_TYPE buffer=EBT_VERTEX_AND_INDEX ) override
void setHardwareMappingHint(E_HARDWARE_MAPPING newMappingHint, E_BUFFER_TYPE buffer = EBT_VERTEX_AND_INDEX) override
{
for (u32 i=0; i<Meshes.size(); ++i)
for (u32 i = 0; i < Meshes.size(); ++i)
Meshes[i]->setHardwareMappingHint(newMappingHint, buffer);
}
//! flags the meshbuffer as changed, reloads hardware buffers
void setDirty(E_BUFFER_TYPE buffer=EBT_VERTEX_AND_INDEX) override
void setDirty(E_BUFFER_TYPE buffer = EBT_VERTEX_AND_INDEX) override
{
for (u32 i=0; i<Meshes.size(); ++i)
for (u32 i = 0; i < Meshes.size(); ++i)
Meshes[i]->setDirty(buffer);
}
//! All meshes defining the animated mesh
core::array<IMesh*> Meshes;
core::array<IMesh *> Meshes;
//! The bounding box of this mesh
core::aabbox3d<f32> Box;
@ -171,8 +171,7 @@ namespace scene
//! The type of the mesh.
E_ANIMATED_MESH_TYPE Type;
};
};
} // end namespace scene
} // end namespace irr

546
include/SColor.h
View File

@ -11,13 +11,13 @@ namespace irr
{
namespace video
{
//! An enum for the color format of textures used by the Irrlicht Engine.
/** A color format specifies how color information is stored.
//! An enum for the color format of textures used by the Irrlicht Engine.
/** A color format specifies how color information is stored.
NOTE: Byte order in memory is usually flipped (it's probably correct in bitmap files, but flipped on reading).
So for example ECF_A8R8G8B8 is BGRA in memory same as in DX9's D3DFMT_A8R8G8B8 format.
*/
enum ECOLOR_FORMAT
{
*/
enum ECOLOR_FORMAT
{
//! 16 bit color format used by the software driver.
/** It is thus preferred by all other irrlicht engine video drivers.
There are 5 bits for every color component, and a single bit is left
@ -85,10 +85,10 @@ namespace video
//! Unknown color format:
ECF_UNKNOWN
};
};
//! Names for ECOLOR_FORMAT types
const c8* const ColorFormatNames[ECF_UNKNOWN+2] =
//! Names for ECOLOR_FORMAT types
const c8 *const ColorFormatNames[ECF_UNKNOWN + 2] =
{
"A1R5G5B5",
"R5G6B5",
@ -108,183 +108,163 @@ namespace video
"D32",
"D24S8",
"UNKNOWN",
0
};
0};
//! Creates a 16 bit A1R5G5B5 color
inline u16 RGBA16(u32 r, u32 g, u32 b, u32 a=0xFF)
{
//! Creates a 16 bit A1R5G5B5 color
inline u16 RGBA16(u32 r, u32 g, u32 b, u32 a = 0xFF)
{
return (u16)((a & 0x80) << 8 |
(r & 0xF8) << 7 |
(g & 0xF8) << 2 |
(b & 0xF8) >> 3);
}
}
//! Creates a 16 bit A1R5G5B5 color
inline u16 RGB16(u32 r, u32 g, u32 b)
{
return RGBA16(r, g, b);
}
//! Creates a 16 bit A1R5G5B5 color
inline u16 RGB16(u32 r, u32 g, u32 b)
{
return RGBA16(r,g,b);
}
//! Creates a 16bit A1R5G5B5 color, based on 16bit input values
inline u16 RGB16from16(u16 r, u16 g, u16 b)
{
//! Creates a 16bit A1R5G5B5 color, based on 16bit input values
inline u16 RGB16from16(u16 r, u16 g, u16 b)
{
return (0x8000 |
(r & 0x1F) << 10 |
(g & 0x1F) << 5 |
(b & 0x1F));
}
}
//! Converts a 32bit (X8R8G8B8) color to a 16bit A1R5G5B5 color
inline u16 X8R8G8B8toA1R5G5B5(u32 color)
{
//! Converts a 32bit (X8R8G8B8) color to a 16bit A1R5G5B5 color
inline u16 X8R8G8B8toA1R5G5B5(u32 color)
{
return (u16)(0x8000 |
( color & 0x00F80000) >> 9 |
( color & 0x0000F800) >> 6 |
( color & 0x000000F8) >> 3);
}
(color & 0x00F80000) >> 9 |
(color & 0x0000F800) >> 6 |
(color & 0x000000F8) >> 3);
}
//! Converts a 32bit (A8R8G8B8) color to a 16bit A1R5G5B5 color
inline u16 A8R8G8B8toA1R5G5B5(u32 color)
{
return (u16)((color & 0x80000000) >> 16 |
(color & 0x00F80000) >> 9 |
(color & 0x0000F800) >> 6 |
(color & 0x000000F8) >> 3);
}
//! Converts a 32bit (A8R8G8B8) color to a 16bit A1R5G5B5 color
inline u16 A8R8G8B8toA1R5G5B5(u32 color)
{
return (u16)(( color & 0x80000000) >> 16|
( color & 0x00F80000) >> 9 |
( color & 0x0000F800) >> 6 |
( color & 0x000000F8) >> 3);
}
//! Converts a 32bit (A8R8G8B8) color to a 16bit R5G6B5 color
inline u16 A8R8G8B8toR5G6B5(u32 color)
{
return (u16)((color & 0x00F80000) >> 8 |
(color & 0x0000FC00) >> 5 |
(color & 0x000000F8) >> 3);
}
//! Convert A8R8G8B8 Color from A1R5G5B5 color
/** build a nicer 32bit Color by extending dest lower bits with source high bits. */
inline u32 A1R5G5B5toA8R8G8B8(u16 color)
{
return (((-((s32)color & 0x00008000) >> (s32)31) & 0xFF000000) |
((color & 0x00007C00) << 9) | ((color & 0x00007000) << 4) |
((color & 0x000003E0) << 6) | ((color & 0x00000380) << 1) |
((color & 0x0000001F) << 3) | ((color & 0x0000001C) >> 2));
}
//! Converts a 32bit (A8R8G8B8) color to a 16bit R5G6B5 color
inline u16 A8R8G8B8toR5G6B5(u32 color)
{
return (u16)(( color & 0x00F80000) >> 8 |
( color & 0x0000FC00) >> 5 |
( color & 0x000000F8) >> 3);
}
//! Convert A8R8G8B8 Color from A1R5G5B5 color
/** build a nicer 32bit Color by extending dest lower bits with source high bits. */
inline u32 A1R5G5B5toA8R8G8B8(u16 color)
{
return ( (( -( (s32) color & 0x00008000 ) >> (s32) 31 ) & 0xFF000000 ) |
(( color & 0x00007C00 ) << 9) | (( color & 0x00007000 ) << 4) |
(( color & 0x000003E0 ) << 6) | (( color & 0x00000380 ) << 1) |
(( color & 0x0000001F ) << 3) | (( color & 0x0000001C ) >> 2)
);
}
//! Returns A8R8G8B8 Color from R5G6B5 color
inline u32 R5G6B5toA8R8G8B8(u16 color)
{
//! Returns A8R8G8B8 Color from R5G6B5 color
inline u32 R5G6B5toA8R8G8B8(u16 color)
{
return 0xFF000000 |
((color & 0xF800) << 8)|
((color & 0x07E0) << 5)|
((color & 0xF800) << 8) |
((color & 0x07E0) << 5) |
((color & 0x001F) << 3);
}
}
//! Returns A1R5G5B5 Color from R5G6B5 color
inline u16 R5G6B5toA1R5G5B5(u16 color)
{
//! Returns A1R5G5B5 Color from R5G6B5 color
inline u16 R5G6B5toA1R5G5B5(u16 color)
{
return 0x8000 | (((color & 0xFFC0) >> 1) | (color & 0x1F));
}
}
//! Returns R5G6B5 Color from A1R5G5B5 color
inline u16 A1R5G5B5toR5G6B5(u16 color)
{
//! Returns R5G6B5 Color from A1R5G5B5 color
inline u16 A1R5G5B5toR5G6B5(u16 color)
{
return (((color & 0x7FE0) << 1) | (color & 0x1F));
}
}
//! Returns the alpha component from A1R5G5B5 color
/** In Irrlicht, alpha refers to opacity.
\return The alpha value of the color. 0 is transparent, 1 is opaque. */
inline u32 getAlpha(u16 color)
{
return ((color >> 15) & 0x1);
}
//! Returns the red component from A1R5G5B5 color.
/** Shift left by 3 to get 8 bit value. */
inline u32 getRed(u16 color)
{
return ((color >> 10) & 0x1F);
}
//! Returns the alpha component from A1R5G5B5 color
/** In Irrlicht, alpha refers to opacity.
\return The alpha value of the color. 0 is transparent, 1 is opaque. */
inline u32 getAlpha(u16 color)
{
return ((color >> 15)&0x1);
}
//! Returns the green component from A1R5G5B5 color
/** Shift left by 3 to get 8 bit value. */
inline u32 getGreen(u16 color)
{
return ((color >> 5) & 0x1F);
}
//! Returns the red component from A1R5G5B5 color.
/** Shift left by 3 to get 8 bit value. */
inline u32 getRed(u16 color)
{
return ((color >> 10)&0x1F);
}
//! Returns the green component from A1R5G5B5 color
/** Shift left by 3 to get 8 bit value. */
inline u32 getGreen(u16 color)
{
return ((color >> 5)&0x1F);
}
//! Returns the blue component from A1R5G5B5 color
/** Shift left by 3 to get 8 bit value. */
inline u32 getBlue(u16 color)
{
//! Returns the blue component from A1R5G5B5 color
/** Shift left by 3 to get 8 bit value. */
inline u32 getBlue(u16 color)
{
return (color & 0x1F);
}
}
//! Returns the average from a 16 bit A1R5G5B5 color
inline s32 getAverage(s16 color)
{
return ((getRed(color) << 3) + (getGreen(color) << 3) + (getBlue(color) << 3)) / 3;
}
//! Returns the average from a 16 bit A1R5G5B5 color
inline s32 getAverage(s16 color)
{
return ((getRed(color)<<3) + (getGreen(color)<<3) + (getBlue(color)<<3)) / 3;
}
//! Class representing a 32 bit ARGB color.
/** The color values for alpha, red, green, and blue are
stored in a single u32. So all four values may be between 0 and 255.
Alpha in Irrlicht is opacity, so 0 is fully transparent, 255 is fully opaque (solid).
This class is used by most parts of the Irrlicht Engine
to specify a color. Another way is using the class SColorf, which
stores the color values in 4 floats.
This class must consist of only one u32 and must not use virtual functions.
*/
class SColor
{
public:
//! Class representing a 32 bit ARGB color.
/** The color values for alpha, red, green, and blue are
stored in a single u32. So all four values may be between 0 and 255.
Alpha in Irrlicht is opacity, so 0 is fully transparent, 255 is fully opaque (solid).
This class is used by most parts of the Irrlicht Engine
to specify a color. Another way is using the class SColorf, which
stores the color values in 4 floats.
This class must consist of only one u32 and must not use virtual functions.
*/
class SColor
{
public:
//! Constructor of the Color. Does nothing.
/** The color value is not initialized to save time. */
SColor() {}
//! Constructs the color from 4 values representing the alpha, red, green and blue component.
/** Must be values between 0 and 255. */
constexpr SColor (u32 a, u32 r, u32 g, u32 b)
: color(((a & 0xff)<<24) | ((r & 0xff)<<16) | ((g & 0xff)<<8) | (b & 0xff)) {}
constexpr SColor(u32 a, u32 r, u32 g, u32 b) :
color(((a & 0xff) << 24) | ((r & 0xff) << 16) | ((g & 0xff) << 8) | (b & 0xff)) {}
//! Constructs the color from a 32 bit value. Could be another color.
constexpr SColor(u32 clr)
: color(clr) {}
constexpr SColor(u32 clr) :
color(clr) {}
//! Returns the alpha component of the color.
/** The alpha component defines how opaque a color is.
\return The alpha value of the color. 0 is fully transparent, 255 is fully opaque. */
u32 getAlpha() const { return color>>24; }
u32 getAlpha() const { return color >> 24; }
//! Returns the red component of the color.
/** \return Value between 0 and 255, specifying how red the color is.
0 means no red, 255 means full red. */
u32 getRed() const { return (color>>16) & 0xff; }
u32 getRed() const { return (color >> 16) & 0xff; }
//! Returns the green component of the color.
/** \return Value between 0 and 255, specifying how green the color is.
0 means no green, 255 means full green. */
u32 getGreen() const { return (color>>8) & 0xff; }
u32 getGreen() const { return (color >> 8) & 0xff; }
//! Returns the blue component of the color.
/** \return Value between 0 and 255, specifying how blue the color is.
@ -294,35 +274,35 @@ namespace video
//! Get lightness of the color in the range [0,255]
f32 getLightness() const
{
return 0.5f*(core::max_(core::max_(getRed(),getGreen()),getBlue())+core::min_(core::min_(getRed(),getGreen()),getBlue()));
return 0.5f * (core::max_(core::max_(getRed(), getGreen()), getBlue()) + core::min_(core::min_(getRed(), getGreen()), getBlue()));
}
//! Get luminance of the color in the range [0,255].
f32 getLuminance() const
{
return 0.3f*getRed() + 0.59f*getGreen() + 0.11f*getBlue();
return 0.3f * getRed() + 0.59f * getGreen() + 0.11f * getBlue();
}
//! Get average intensity of the color in the range [0,255].
u32 getAverage() const
{
return ( getRed() + getGreen() + getBlue() ) / 3;
return (getRed() + getGreen() + getBlue()) / 3;
}
//! Sets the alpha component of the Color.
/** The alpha component defines how transparent a color should be.
\param a The alpha value of the color. 0 is fully transparent, 255 is fully opaque. */
void setAlpha(u32 a) { color = ((a & 0xff)<<24) | (color & 0x00ffffff); }
void setAlpha(u32 a) { color = ((a & 0xff) << 24) | (color & 0x00ffffff); }
//! Sets the red component of the Color.
/** \param r: Has to be a value between 0 and 255.
0 means no red, 255 means full red. */
void setRed(u32 r) { color = ((r & 0xff)<<16) | (color & 0xff00ffff); }
void setRed(u32 r) { color = ((r & 0xff) << 16) | (color & 0xff00ffff); }
//! Sets the green component of the Color.
/** \param g: Has to be a value between 0 and 255.
0 means no green, 255 means full green. */
void setGreen(u32 g) { color = ((g & 0xff)<<8) | (color & 0xffff00ff); }
void setGreen(u32 g) { color = ((g & 0xff) << 8) | (color & 0xffff00ff); }
//! Sets the blue component of the Color.
/** \param b: Has to be a value between 0 and 255.
@ -337,7 +317,7 @@ namespace video
/** From ARGB to RGBA in 4 byte components for endian aware
passing to OpenGL
\param dest: address where the 4x8 bit OpenGL color is stored. */
void toOpenGLColor(u8* dest) const
void toOpenGLColor(u8 *dest) const
{
*dest = (u8)getRed();
*++dest = (u8)getGreen();
@ -362,26 +342,26 @@ namespace video
value between 0 and 255. 0 means no blue, 255 means full blue. */
void set(u32 a, u32 r, u32 g, u32 b)
{
color = (((a & 0xff)<<24) | ((r & 0xff)<<16) | ((g & 0xff)<<8) | (b & 0xff));
color = (((a & 0xff) << 24) | ((r & 0xff) << 16) | ((g & 0xff) << 8) | (b & 0xff));
}
void set(u32 col) { color = col; }
//! Compares the color to another color.
/** \return True if the colors are the same, and false if not. */
bool operator==(const SColor& other) const { return other.color == color; }
bool operator==(const SColor &other) const { return other.color == color; }
//! Compares the color to another color.
/** \return True if the colors are different, and false if they are the same. */
bool operator!=(const SColor& other) const { return other.color != color; }
bool operator!=(const SColor &other) const { return other.color != color; }
//! comparison operator
/** \return True if this color is smaller than the other one */
bool operator<(const SColor& other) const { return (color < other.color); }
bool operator<(const SColor &other) const { return (color < other.color); }
//! Adds two colors, result is clamped to 0..255 values
/** \param other Color to add to this color
\return Addition of the two colors, clamped to 0..255 values */
SColor operator+(const SColor& other) const
SColor operator+(const SColor &other) const
{
return SColor(core::min_(getAlpha() + other.getAlpha(), 255u),
core::min_(getRed() + other.getRed(), 255u),
@ -397,17 +377,17 @@ namespace video
{
d = core::clamp(d, 0.f, 1.f);
const f32 inv = 1.0f - d;
return SColor((u32)core::round32(other.getAlpha()*inv + getAlpha()*d),
(u32)core::round32(other.getRed()*inv + getRed()*d),
(u32)core::round32(other.getGreen()*inv + getGreen()*d),
(u32)core::round32(other.getBlue()*inv + getBlue()*d));
return SColor((u32)core::round32(other.getAlpha() * inv + getAlpha() * d),
(u32)core::round32(other.getRed() * inv + getRed() * d),
(u32)core::round32(other.getGreen() * inv + getGreen() * d),
(u32)core::round32(other.getBlue() * inv + getBlue() * d));
}
//! Returns interpolated color. ( quadratic )
/** \param c1: first color to interpolate with
\param c2: second color to interpolate with
\param d: value between 0.0f and 1.0f. */
SColor getInterpolated_quadratic(const SColor& c1, const SColor& c2, f32 d) const
SColor getInterpolated_quadratic(const SColor &c1, const SColor &c2, f32 d) const
{
// this*(1-d)*(1-d) + 2 * c1 * (1-d) + c2 * d * d;
d = core::clamp(d, 0.f, 1.f);
@ -417,14 +397,18 @@ namespace video
const f32 mul2 = d * d;
return SColor(
core::clamp( core::floor32(
getAlpha() * mul0 + c1.getAlpha() * mul1 + c2.getAlpha() * mul2 ), 0, 255 ),
core::clamp( core::floor32(
getRed() * mul0 + c1.getRed() * mul1 + c2.getRed() * mul2 ), 0, 255 ),
core::clamp ( core::floor32(
getGreen() * mul0 + c1.getGreen() * mul1 + c2.getGreen() * mul2 ), 0, 255 ),
core::clamp ( core::floor32(
getBlue() * mul0 + c1.getBlue() * mul1 + c2.getBlue() * mul2 ), 0, 255 ));
core::clamp(core::floor32(
getAlpha() * mul0 + c1.getAlpha() * mul1 + c2.getAlpha() * mul2),
0, 255),
core::clamp(core::floor32(
getRed() * mul0 + c1.getRed() * mul1 + c2.getRed() * mul2),
0, 255),
core::clamp(core::floor32(
getGreen() * mul0 + c1.getGreen() * mul1 + c2.getGreen() * mul2),
0, 255),
core::clamp(core::floor32(
getBlue() * mul0 + c1.getBlue() * mul1 + c2.getBlue() * mul2),
0, 255));
}
//! set the color by expecting data in the given format
@ -433,23 +417,20 @@ namespace video
*/
void setData(const void *data, ECOLOR_FORMAT format)
{
switch (format)
{
switch (format) {
case ECF_A1R5G5B5:
color = A1R5G5B5toA8R8G8B8(*(u16*)data);
color = A1R5G5B5toA8R8G8B8(*(u16 *)data);
break;
case ECF_R5G6B5:
color = R5G6B5toA8R8G8B8(*(u16*)data);
color = R5G6B5toA8R8G8B8(*(u16 *)data);
break;
case ECF_A8R8G8B8:
color = *(u32*)data;
break;
case ECF_R8G8B8:
{
const u8* p = (u8*)data;
set(255, p[0],p[1],p[2]);
}
color = *(u32 *)data;
break;
case ECF_R8G8B8: {
const u8 *p = (u8 *)data;
set(255, p[0], p[1], p[2]);
} break;
default:
color = 0xffffffff;
break;
@ -462,37 +443,28 @@ namespace video
*/
void getData(void *data, ECOLOR_FORMAT format) const
{
switch(format)
{
case ECF_A1R5G5B5:
{
u16 * dest = (u16*)data;
*dest = video::A8R8G8B8toA1R5G5B5( color );
}
break;
switch (format) {
case ECF_A1R5G5B5: {
u16 *dest = (u16 *)data;
*dest = video::A8R8G8B8toA1R5G5B5(color);
} break;
case ECF_R5G6B5:
{
u16 * dest = (u16*)data;
*dest = video::A8R8G8B8toR5G6B5( color );
}
break;
case ECF_R5G6B5: {
u16 *dest = (u16 *)data;
*dest = video::A8R8G8B8toR5G6B5(color);
} break;
case ECF_R8G8B8:
{
u8* dest = (u8*)data;
case ECF_R8G8B8: {
u8 *dest = (u8 *)data;
dest[0] = (u8)getRed();
dest[1] = (u8)getGreen();
dest[2] = (u8)getBlue();
}
break;
} break;
case ECF_A8R8G8B8:
{
u32 * dest = (u32*)data;
case ECF_A8R8G8B8: {
u32 *dest = (u32 *)data;
*dest = color;
}
break;
} break;
default:
break;
@ -501,22 +473,22 @@ namespace video
//! color in A8R8G8B8 Format
u32 color;
};
};
//! Class representing a color with four floats.
/** The color values for red, green, blue
and alpha are each stored in a 32 bit floating point variable.
So all four values may be between 0.0f and 1.0f.
Another, faster way to define colors is using the class SColor, which
stores the color values in a single 32 bit integer.
*/
class SColorf
{
public:
//! Class representing a color with four floats.
/** The color values for red, green, blue
and alpha are each stored in a 32 bit floating point variable.
So all four values may be between 0.0f and 1.0f.
Another, faster way to define colors is using the class SColor, which
stores the color values in a single 32 bit integer.
*/
class SColorf
{
public:
//! Default constructor for SColorf.
/** Sets red, green and blue to 0.0f and alpha to 1.0f. */
SColorf() : r(0.0f), g(0.0f), b(0.0f), a(1.0f) {}
SColorf() :
r(0.0f), g(0.0f), b(0.0f), a(1.0f) {}
//! Constructs a color from up to four color values: red, green, blue, and alpha.
/** \param r: Red color component. Should be a value between
@ -529,7 +501,8 @@ namespace video
component defines how transparent a color should be. Has to be
a value between 0.0f and 1.0f, 1.0f means not transparent
(opaque), 0.0f means fully transparent. */
SColorf(f32 r, f32 g, f32 b, f32 a = 1.0f) : r(r), g(g), b(b), a(a) {}
SColorf(f32 r, f32 g, f32 b, f32 a = 1.0f) :
r(r), g(g), b(b), a(a) {}
//! Constructs a color from 32 bit Color.
/** \param c: 32 bit color from which this SColorf class is
@ -546,7 +519,7 @@ namespace video
//! Converts this color to a SColor without floats.
SColor toSColor() const
{
return SColor((u32)core::round32(a*255.0f), (u32)core::round32(r*255.0f), (u32)core::round32(g*255.0f), (u32)core::round32(b*255.0f));
return SColor((u32)core::round32(a * 255.0f), (u32)core::round32(r * 255.0f), (u32)core::round32(g * 255.0f), (u32)core::round32(b * 255.0f));
}
//! Sets three color components to new values at once.
@ -556,7 +529,12 @@ namespace video
no green (=black) and 1.0f, meaning full green.
\param bb: Blue color component. Should be a value between 0.0f meaning
no blue (=black) and 1.0f, meaning full blue. */
void set(f32 rr, f32 gg, f32 bb) {r = rr; g =gg; b = bb; }
void set(f32 rr, f32 gg, f32 bb)
{
r = rr;
g = gg;
b = bb;
}
//! Sets all four color components to new values at once.
/** \param aa: Alpha component. Should be a value between 0.0f meaning
@ -567,7 +545,13 @@ namespace video
no green and 1.0f, meaning full green.
\param bb: Blue color component. Should be a value between 0.0f meaning
no blue and 1.0f, meaning full blue. */
void set(f32 aa, f32 rr, f32 gg, f32 bb) {a = aa; r = rr; g =gg; b = bb; }
void set(f32 aa, f32 rr, f32 gg, f32 bb)
{
a = aa;
r = rr;
g = gg;
b = bb;
}
//! Interpolates the color with a f32 value to another color
/** \param other: Other color
@ -577,15 +561,15 @@ namespace video
{
d = core::clamp(d, 0.f, 1.f);
const f32 inv = 1.0f - d;
return SColorf(other.r*inv + r*d,
other.g*inv + g*d, other.b*inv + b*d, other.a*inv + a*d);
return SColorf(other.r * inv + r * d,
other.g * inv + g * d, other.b * inv + b * d, other.a * inv + a * d);
}
//! Returns interpolated color. ( quadratic )
/** \param c1: first color to interpolate with
\param c2: second color to interpolate with
\param d: value between 0.0f and 1.0f. */
inline SColorf getInterpolated_quadratic(const SColorf& c1, const SColorf& c2,
inline SColorf getInterpolated_quadratic(const SColorf &c1, const SColorf &c2,
f32 d) const
{
d = core::clamp(d, 0.f, 1.f);
@ -595,22 +579,28 @@ namespace video
const f32 mul1 = 2.f * d * inv;
const f32 mul2 = d * d;
return SColorf (r * mul0 + c1.r * mul1 + c2.r * mul2,
return SColorf(r * mul0 + c1.r * mul1 + c2.r * mul2,
g * mul0 + c1.g * mul1 + c2.g * mul2,
b * mul0 + c1.b * mul1 + c2.b * mul2,
a * mul0 + c1.a * mul1 + c2.a * mul2);
}
//! Sets a color component by index. R=0, G=1, B=2, A=3
void setColorComponentValue(s32 index, f32 value)
{
switch(index)
{
case 0: r = value; break;
case 1: g = value; break;
case 2: b = value; break;
case 3: a = value; break;
switch (index) {
case 0:
r = value;
break;
case 1:
g = value;
break;
case 2:
b = value;
break;
case 3:
a = value;
break;
}
}
@ -637,19 +627,18 @@ namespace video
//! alpha color component
f32 a;
};
};
//! Class representing a color in HSL format
/** The color values for hue, saturation, luminance
are stored in 32bit floating point variables. Hue is in range [0,360],
Luminance and Saturation are in percent [0,100]
*/
class SColorHSL
{
public:
constexpr SColorHSL ( f32 h = 0.f, f32 s = 0.f, f32 l = 0.f )
: Hue ( h ), Saturation ( s ), Luminance ( l ) {}
//! Class representing a color in HSL format
/** The color values for hue, saturation, luminance
are stored in 32bit floating point variables. Hue is in range [0,360],
Luminance and Saturation are in percent [0,100]
*/
class SColorHSL
{
public:
constexpr SColorHSL(f32 h = 0.f, f32 s = 0.f, f32 l = 0.f) :
Hue(h), Saturation(s), Luminance(l) {}
void fromRGB(const SColorf &color);
void toRGB(SColorf &color) const;
@ -658,50 +647,44 @@ namespace video
f32 Saturation;
f32 Luminance;
private:
private:
inline f32 toRGB1(f32 rm1, f32 rm2, f32 rh) const;
};
};
inline void SColorHSL::fromRGB(const SColorf &color)
{
inline void SColorHSL::fromRGB(const SColorf &color)
{
const f32 maxVal = core::max_(color.getRed(), color.getGreen(), color.getBlue());
const f32 minVal = (f32)core::min_(color.getRed(), color.getGreen(), color.getBlue());
Luminance = (maxVal+minVal)*50;
if (core::equals(maxVal, minVal))
{
Hue=0.f;
Saturation=0.f;
Luminance = (maxVal + minVal) * 50;
if (core::equals(maxVal, minVal)) {
Hue = 0.f;
Saturation = 0.f;
return;
}
const f32 delta = maxVal-minVal;
if ( Luminance <= 50 )
{
Saturation = (delta)/(maxVal+minVal);
}
else
{
Saturation = (delta)/(2-maxVal-minVal);
const f32 delta = maxVal - minVal;
if (Luminance <= 50) {
Saturation = (delta) / (maxVal + minVal);
} else {
Saturation = (delta) / (2 - maxVal - minVal);
}
Saturation *= 100;
if (core::equals(maxVal, color.getRed()))
Hue = (color.getGreen()-color.getBlue())/delta;
Hue = (color.getGreen() - color.getBlue()) / delta;
else if (core::equals(maxVal, color.getGreen()))
Hue = 2+((color.getBlue()-color.getRed())/delta);
Hue = 2 + ((color.getBlue() - color.getRed()) / delta);
else // blue is max
Hue = 4+((color.getRed()-color.getGreen())/delta);
Hue = 4 + ((color.getRed() - color.getGreen()) / delta);
Hue *= 60.0f;
while ( Hue < 0.f )
while (Hue < 0.f)
Hue += 360;
}
}
inline void SColorHSL::toRGB(SColorf &color) const
{
const f32 l = Luminance/100;
inline void SColorHSL::toRGB(SColorf &color) const
{
const f32 l = Luminance / 100;
if (core::iszero(Saturation)) // grey
{
color.set(l, l, l);
@ -710,42 +693,37 @@ namespace video
f32 rm2;
if ( Luminance <= 50 )
{
rm2 = l + l * (Saturation/100);
}
else
{
rm2 = l + (1 - l) * (Saturation/100);
if (Luminance <= 50) {
rm2 = l + l * (Saturation / 100);
} else {
rm2 = l + (1 - l) * (Saturation / 100);
}
const f32 rm1 = 2.0f * l - rm2;
const f32 h = Hue / 360.0f;
color.set( toRGB1(rm1, rm2, h + 1.f/3.f),
color.set(toRGB1(rm1, rm2, h + 1.f / 3.f),
toRGB1(rm1, rm2, h),
toRGB1(rm1, rm2, h - 1.f/3.f)
);
}
toRGB1(rm1, rm2, h - 1.f / 3.f));
}
// algorithm from Foley/Van-Dam
inline f32 SColorHSL::toRGB1(f32 rm1, f32 rm2, f32 rh) const
{
if (rh<0)
// algorithm from Foley/Van-Dam
inline f32 SColorHSL::toRGB1(f32 rm1, f32 rm2, f32 rh) const
{
if (rh < 0)
rh += 1;
if (rh>1)
if (rh > 1)
rh -= 1;
if (rh < 1.f/6.f)
rm1 = rm1 + (rm2 - rm1) * rh*6.f;
if (rh < 1.f / 6.f)
rm1 = rm1 + (rm2 - rm1) * rh * 6.f;
else if (rh < 0.5f)
rm1 = rm2;
else if (rh < 2.f/3.f)
rm1 = rm1 + (rm2 - rm1) * ((2.f/3.f)-rh)*6.f;
else if (rh < 2.f / 3.f)
rm1 = rm1 + (rm2 - rm1) * ((2.f / 3.f) - rh) * 6.f;
return rm1;
}
}
} // end namespace video
} // end namespace irr

32
include/SExposedVideoData.h
View File

@ -17,29 +17,39 @@ you are using the software or the null device.
*/
struct SExposedVideoData
{
SExposedVideoData() {OpenGLWin32.HDc=0; OpenGLWin32.HRc=0; OpenGLWin32.HWnd=0;}
explicit SExposedVideoData(void* Window) {OpenGLWin32.HDc=0; OpenGLWin32.HRc=0; OpenGLWin32.HWnd=Window;}
SExposedVideoData()
{
OpenGLWin32.HDc = 0;
OpenGLWin32.HRc = 0;
OpenGLWin32.HWnd = 0;
}
explicit SExposedVideoData(void *Window)
{
OpenGLWin32.HDc = 0;
OpenGLWin32.HRc = 0;
OpenGLWin32.HWnd = Window;
}
struct SOpenGLWin32
{
//! Private GDI Device Context.
/** Get if for example with: HDC h = reinterpret_cast<HDC>(exposedData.OpenGLWin32.HDc) */
void* HDc;
void *HDc;
//! Permanent Rendering Context.
/** Get if for example with: HGLRC h = reinterpret_cast<HGLRC>(exposedData.OpenGLWin32.HRc) */
void* HRc;
void *HRc;
//! Window handle.
/** Get with for example with: HWND h = reinterpret_cast<HWND>(exposedData.OpenGLWin32.HWnd) */
void* HWnd;
void *HWnd;
};
struct SOpenGLLinux
{
// XWindow handles
void* X11Display;
void* X11Context;
void *X11Display;
void *X11Context;
unsigned long X11Window;
unsigned long GLXWindow;
};
@ -47,22 +57,22 @@ struct SExposedVideoData
struct SOpenGLOSX
{
//! The NSOpenGLContext object.
void* Context;
void *Context;
//! The NSWindow object.
void* Window;
void *Window;
};
struct SOpenGLFB
{
//! The EGLNativeWindowType object.
void* Window;
void *Window;
};
struct SOGLESAndroid
{
//! The ANativeWindow object.
void* Window;
void *Window;
};
union

29
include/SIrrCreationParameters.h
View File

@ -14,18 +14,18 @@
namespace irr
{
class IEventReceiver;
class IEventReceiver;
//! Structure for holding Irrlicht Device creation parameters.
/** This structure is used in the createDeviceEx() function. */
struct SIrrlichtCreationParameters
{
//! Structure for holding Irrlicht Device creation parameters.
/** This structure is used in the createDeviceEx() function. */
struct SIrrlichtCreationParameters
{
//! Constructs a SIrrlichtCreationParameters structure with default values.
SIrrlichtCreationParameters() :
DeviceType(EIDT_BEST),
DriverType(video::EDT_OPENGL),
WindowSize(core::dimension2d<u32>(800, 600)),
WindowPosition(core::position2di(-1,-1)),
WindowPosition(core::position2di(-1, -1)),
Bits(32),
ZBufferBits(24),
Fullscreen(false),
@ -54,11 +54,13 @@ namespace irr
{
}
SIrrlichtCreationParameters(const SIrrlichtCreationParameters& other) :
SIrrlichtCreationParameters(const SIrrlichtCreationParameters &other) :
SDK_version_do_not_use(IRRLICHT_SDK_VERSION)
{*this = other;}
{
*this = other;
}
SIrrlichtCreationParameters& operator=(const SIrrlichtCreationParameters& other)
SIrrlichtCreationParameters &operator=(const SIrrlichtCreationParameters &other)
{
DeviceType = other.DeviceType;
DriverType = other.DriverType;
@ -182,7 +184,7 @@ namespace irr
bool Stereobuffer;
//! A user created event receiver.
IEventReceiver* EventReceiver;
IEventReceiver *EventReceiver;
//! Window Id.
/** If this is set to a value other than 0, the Irrlicht Engine
@ -235,7 +237,7 @@ namespace irr
\endcode
However, there is no need to draw the picture this often. Just
do it how you like. */
void* WindowId;
void *WindowId;
//! Specifies the logging level used in the logging interface.
/** The default value is ELL_INFORMATION. You can access the ILogger interface
@ -248,7 +250,7 @@ namespace irr
//! Don't use or change this parameter.
/** Always set it to IRRLICHT_SDK_VERSION, which is done by default.
This is needed for sdk version checks. */
const c8* const SDK_version_do_not_use;
const c8 *const SDK_version_do_not_use;
//! Define some private data storage.
/** Used when platform devices need access to OS specific data structures etc.
@ -260,7 +262,6 @@ namespace irr
/** This is about the shaders which can be found in media/Shaders by default. It's only necessary
to set when using OGL-ES 2.0 */
irr::io::path OGLES2ShaderPath;
};
};
} // end namespace irr

326
include/SMaterial.h
View File

@ -17,12 +17,12 @@ namespace irr
{
namespace video
{
class ITexture;
class ITexture;
//! Flag for MaterialTypeParam (in combination with EMT_ONETEXTURE_BLEND) or for BlendFactor
//! BlendFunc = source * sourceFactor + dest * destFactor
enum E_BLEND_FACTOR
{
//! Flag for MaterialTypeParam (in combination with EMT_ONETEXTURE_BLEND) or for BlendFactor
//! BlendFunc = source * sourceFactor + dest * destFactor
enum E_BLEND_FACTOR
{
EBF_ZERO = 0, //!< src & dest (0, 0, 0, 0)
EBF_ONE, //!< src & dest (1, 1, 1, 1)
EBF_DST_COLOR, //!< src (destR, destG, destB, destA)
@ -34,40 +34,40 @@ namespace video
EBF_DST_ALPHA, //!< src & dest (destA, destA, destA, destA)
EBF_ONE_MINUS_DST_ALPHA, //!< src & dest (1-destA, 1-destA, 1-destA, 1-destA)
EBF_SRC_ALPHA_SATURATE //!< src (min(srcA, 1-destA), idem, ...)
};
};
//! Values defining the blend operation
enum E_BLEND_OPERATION
{
//! Values defining the blend operation
enum E_BLEND_OPERATION
{
EBO_NONE = 0, //!< No blending happens
EBO_ADD, //!< Default blending adds the color values
EBO_SUBTRACT, //!< This mode subtracts the color values
EBO_REVSUBTRACT,//!< This modes subtracts destination from source
EBO_REVSUBTRACT, //!< This modes subtracts destination from source
EBO_MIN, //!< Choose minimum value of each color channel
EBO_MAX, //!< Choose maximum value of each color channel
EBO_MIN_FACTOR, //!< Choose minimum value of each color channel after applying blend factors, not widely supported
EBO_MAX_FACTOR, //!< Choose maximum value of each color channel after applying blend factors, not widely supported
EBO_MIN_ALPHA, //!< Choose minimum value of each color channel based on alpha value, not widely supported
EBO_MAX_ALPHA //!< Choose maximum value of each color channel based on alpha value, not widely supported
};
};
//! MaterialTypeParam: e.g. DirectX: D3DTOP_MODULATE, D3DTOP_MODULATE2X, D3DTOP_MODULATE4X
enum E_MODULATE_FUNC
{
//! MaterialTypeParam: e.g. DirectX: D3DTOP_MODULATE, D3DTOP_MODULATE2X, D3DTOP_MODULATE4X
enum E_MODULATE_FUNC
{
EMFN_MODULATE_1X = 1,
EMFN_MODULATE_2X = 2,
EMFN_MODULATE_4X = 4
};
};
//! Comparison function, e.g. for depth buffer test
enum E_COMPARISON_FUNC
{
//! Comparison function, e.g. for depth buffer test
enum E_COMPARISON_FUNC
{
//! Depth test disabled (disable also write to depth buffer)
ECFN_DISABLED=0,
ECFN_DISABLED = 0,
//! <= test, default for e.g. depth test
ECFN_LESSEQUAL=1,
ECFN_LESSEQUAL = 1,
//! Exact equality
ECFN_EQUAL=2,
ECFN_EQUAL = 2,
//! exclusive less comparison, i.e. <
ECFN_LESS,
//! Succeeds almost always, except for exact equality
@ -80,91 +80,90 @@ namespace video
ECFN_ALWAYS,
//! Test never succeeds
ECFN_NEVER
};
};
//! Enum values for enabling/disabling color planes for rendering
enum E_COLOR_PLANE
{
//! Enum values for enabling/disabling color planes for rendering
enum E_COLOR_PLANE
{
//! No color enabled
ECP_NONE=0,
ECP_NONE = 0,
//! Alpha enabled
ECP_ALPHA=1,
ECP_ALPHA = 1,
//! Red enabled
ECP_RED=2,
ECP_RED = 2,
//! Green enabled
ECP_GREEN=4,
ECP_GREEN = 4,
//! Blue enabled
ECP_BLUE=8,
ECP_BLUE = 8,
//! All colors, no alpha
ECP_RGB=14,
ECP_RGB = 14,
//! All planes enabled
ECP_ALL=15
};
ECP_ALL = 15
};
//! Source of the alpha value to take
/** This is currently only supported in EMT_ONETEXTURE_BLEND. You can use an
or'ed combination of values. Alpha values are modulated (multiplied). */
enum E_ALPHA_SOURCE
{
//! Source of the alpha value to take
/** This is currently only supported in EMT_ONETEXTURE_BLEND. You can use an
or'ed combination of values. Alpha values are modulated (multiplied). */
enum E_ALPHA_SOURCE
{
//! Use no alpha, somewhat redundant with other settings
EAS_NONE=0,
EAS_NONE = 0,
//! Use vertex color alpha
EAS_VERTEX_COLOR,
//! Use texture alpha channel
EAS_TEXTURE
};
};
//! Pack srcFact, dstFact, Modulate and alpha source to MaterialTypeParam or BlendFactor
/** alpha source can be an OR'ed combination of E_ALPHA_SOURCE values. */
inline f32 pack_textureBlendFunc(const E_BLEND_FACTOR srcFact, const E_BLEND_FACTOR dstFact,
const E_MODULATE_FUNC modulate=EMFN_MODULATE_1X, const u32 alphaSource=EAS_TEXTURE)
{
//! Pack srcFact, dstFact, Modulate and alpha source to MaterialTypeParam or BlendFactor
/** alpha source can be an OR'ed combination of E_ALPHA_SOURCE values. */
inline f32 pack_textureBlendFunc(const E_BLEND_FACTOR srcFact, const E_BLEND_FACTOR dstFact,
const E_MODULATE_FUNC modulate = EMFN_MODULATE_1X, const u32 alphaSource = EAS_TEXTURE)
{
const u32 tmp = (alphaSource << 20) | (modulate << 16) | (srcFact << 12) | (dstFact << 8) | (srcFact << 4) | dstFact;
return FR(tmp);
}
}
//! Pack srcRGBFact, dstRGBFact, srcAlphaFact, dstAlphaFact, Modulate and alpha source to MaterialTypeParam or BlendFactor
/** alpha source can be an OR'ed combination of E_ALPHA_SOURCE values. */
inline f32 pack_textureBlendFuncSeparate(const E_BLEND_FACTOR srcRGBFact, const E_BLEND_FACTOR dstRGBFact,
//! Pack srcRGBFact, dstRGBFact, srcAlphaFact, dstAlphaFact, Modulate and alpha source to MaterialTypeParam or BlendFactor
/** alpha source can be an OR'ed combination of E_ALPHA_SOURCE values. */
inline f32 pack_textureBlendFuncSeparate(const E_BLEND_FACTOR srcRGBFact, const E_BLEND_FACTOR dstRGBFact,
const E_BLEND_FACTOR srcAlphaFact, const E_BLEND_FACTOR dstAlphaFact,
const E_MODULATE_FUNC modulate=EMFN_MODULATE_1X, const u32 alphaSource=EAS_TEXTURE)
{
const E_MODULATE_FUNC modulate = EMFN_MODULATE_1X, const u32 alphaSource = EAS_TEXTURE)
{
const u32 tmp = (alphaSource << 20) | (modulate << 16) | (srcAlphaFact << 12) | (dstAlphaFact << 8) | (srcRGBFact << 4) | dstRGBFact;
return FR(tmp);
}
}
//! Unpack srcFact, dstFact, modulo and alphaSource factors
/** The fields don't use the full byte range, so we could pack even more... */
inline void unpack_textureBlendFunc(E_BLEND_FACTOR &srcFact, E_BLEND_FACTOR &dstFact,
E_MODULATE_FUNC &modulo, u32& alphaSource, const f32 param)
{
//! Unpack srcFact, dstFact, modulo and alphaSource factors
/** The fields don't use the full byte range, so we could pack even more... */
inline void unpack_textureBlendFunc(E_BLEND_FACTOR &srcFact, E_BLEND_FACTOR &dstFact,
E_MODULATE_FUNC &modulo, u32 &alphaSource, const f32 param)
{
const u32 state = IR(param);
alphaSource = (state & 0x00F00000) >> 20;
modulo = E_MODULATE_FUNC( ( state & 0x000F0000 ) >> 16 );
srcFact = E_BLEND_FACTOR ( ( state & 0x000000F0 ) >> 4 );
dstFact = E_BLEND_FACTOR ( ( state & 0x0000000F ) );
}
modulo = E_MODULATE_FUNC((state & 0x000F0000) >> 16);
srcFact = E_BLEND_FACTOR((state & 0x000000F0) >> 4);
dstFact = E_BLEND_FACTOR((state & 0x0000000F));
}
//! Unpack srcRGBFact, dstRGBFact, srcAlphaFact, dstAlphaFact, modulo and alphaSource factors
/** The fields don't use the full byte range, so we could pack even more... */
inline void unpack_textureBlendFuncSeparate(E_BLEND_FACTOR &srcRGBFact, E_BLEND_FACTOR &dstRGBFact,
//! Unpack srcRGBFact, dstRGBFact, srcAlphaFact, dstAlphaFact, modulo and alphaSource factors
/** The fields don't use the full byte range, so we could pack even more... */
inline void unpack_textureBlendFuncSeparate(E_BLEND_FACTOR &srcRGBFact, E_BLEND_FACTOR &dstRGBFact,
E_BLEND_FACTOR &srcAlphaFact, E_BLEND_FACTOR &dstAlphaFact,
E_MODULATE_FUNC &modulo, u32& alphaSource, const f32 param)
{
E_MODULATE_FUNC &modulo, u32 &alphaSource, const f32 param)
{
const u32 state = IR(param);
alphaSource = (state & 0x00F00000) >> 20;
modulo = E_MODULATE_FUNC( ( state & 0x000F0000 ) >> 16 );
srcAlphaFact = E_BLEND_FACTOR ( ( state & 0x0000F000 ) >> 12 );
dstAlphaFact = E_BLEND_FACTOR ( ( state & 0x00000F00 ) >> 8 );
srcRGBFact = E_BLEND_FACTOR ( ( state & 0x000000F0 ) >> 4 );
dstRGBFact = E_BLEND_FACTOR ( ( state & 0x0000000F ) );
}
modulo = E_MODULATE_FUNC((state & 0x000F0000) >> 16);
srcAlphaFact = E_BLEND_FACTOR((state & 0x0000F000) >> 12);
dstAlphaFact = E_BLEND_FACTOR((state & 0x00000F00) >> 8);
srcRGBFact = E_BLEND_FACTOR((state & 0x000000F0) >> 4);
dstRGBFact = E_BLEND_FACTOR((state & 0x0000000F));
}
//! has blend factor alphablending
inline bool textureBlendFunc_hasAlpha ( const E_BLEND_FACTOR factor )
{
switch ( factor )
{
//! has blend factor alphablending
inline bool textureBlendFunc_hasAlpha(const E_BLEND_FACTOR factor)
{
switch (factor) {
case EBF_SRC_ALPHA:
case EBF_ONE_MINUS_SRC_ALPHA:
case EBF_DST_ALPHA:
@ -174,40 +173,39 @@ namespace video
default:
return false;
}
}
}
//! These flags are used to specify the anti-aliasing and smoothing modes
/** Techniques supported are multisampling, geometry smoothing, and alpha
to coverage.
Some drivers don't support a per-material setting of the anti-aliasing
modes. In those cases, FSAA/multisampling is defined by the device mode
chosen upon creation via irr::SIrrCreationParameters.
*/
enum E_ANTI_ALIASING_MODE
{
//! These flags are used to specify the anti-aliasing and smoothing modes
/** Techniques supported are multisampling, geometry smoothing, and alpha
to coverage.
Some drivers don't support a per-material setting of the anti-aliasing
modes. In those cases, FSAA/multisampling is defined by the device mode
chosen upon creation via irr::SIrrCreationParameters.
*/
enum E_ANTI_ALIASING_MODE
{
//! Use to turn off anti-aliasing for this material
EAAM_OFF=0,
EAAM_OFF = 0,
//! Default anti-aliasing mode
EAAM_SIMPLE=1,
EAAM_SIMPLE = 1,
//! High-quality anti-aliasing, not always supported, automatically enables SIMPLE mode
EAAM_QUALITY=3,
EAAM_QUALITY = 3,
//! Enhanced anti-aliasing for transparent materials
/** Usually used with EMT_TRANSPARENT_ALPHA_CHANNEL_REF and multisampling. */
EAAM_ALPHA_TO_COVERAGE=4
};
EAAM_ALPHA_TO_COVERAGE = 4
};
//! These flags allow to define the interpretation of vertex color when lighting is enabled
/** Without lighting being enabled the vertex color is the only value defining the fragment color.
Once lighting is enabled, the four values for diffuse, ambient, emissive, and specular take over.
With these flags it is possible to define which lighting factor shall be defined by the vertex color
instead of the lighting factor which is the same for all faces of that material.
The default is to use vertex color for the diffuse value, another pretty common value is to use
vertex color for both diffuse and ambient factor. */
enum E_COLOR_MATERIAL
{
//! These flags allow to define the interpretation of vertex color when lighting is enabled
/** Without lighting being enabled the vertex color is the only value defining the fragment color.
Once lighting is enabled, the four values for diffuse, ambient, emissive, and specular take over.
With these flags it is possible to define which lighting factor shall be defined by the vertex color
instead of the lighting factor which is the same for all faces of that material.
The default is to use vertex color for the diffuse value, another pretty common value is to use
vertex color for both diffuse and ambient factor. */
enum E_COLOR_MATERIAL
{
//! Don't use vertex color for lighting
ECM_NONE=0,
ECM_NONE = 0,
//! Use vertex color for diffuse light, this is default
ECM_DIFFUSE,
//! Use vertex color for ambient light
@ -218,19 +216,18 @@ namespace video
ECM_SPECULAR,
//! Use vertex color for both diffuse and ambient light
ECM_DIFFUSE_AND_AMBIENT
};
};
//! Names for polygon offset direction
const c8* const PolygonOffsetDirectionNames[] =
//! Names for polygon offset direction
const c8 *const PolygonOffsetDirectionNames[] =
{
"Back",
"Front",
0
};
0};
//! For SMaterial.ZWriteEnable
enum E_ZWRITE
{
//! For SMaterial.ZWriteEnable
enum E_ZWRITE
{
//! zwrite always disabled for this material
EZW_OFF = 0,
@ -243,30 +240,27 @@ namespace video
//! zwrite always enabled for this material
EZW_ON
};
};
//! Names for E_ZWRITE
const c8* const ZWriteNames[] =
//! Names for E_ZWRITE
const c8 *const ZWriteNames[] =
{
"Off",
"Auto",
"On",
0
};
0};
//! Maximum number of texture an SMaterial can have.
/** SMaterial might ignore some textures in most function, like assignment and comparison,
//! Maximum number of texture an SMaterial can have.
/** SMaterial might ignore some textures in most function, like assignment and comparison,
when SIrrlichtCreationParameters::MaxTextureUnits is set to a lower number.
*/
const u32 MATERIAL_MAX_TEXTURES = 4;
*/
const u32 MATERIAL_MAX_TEXTURES = 4;
//! Struct for holding parameters for a material renderer
// Note for implementors: Serialization is in CNullDriver
class SMaterial
{
public:
//! Struct for holding parameters for a material renderer
// Note for implementors: Serialization is in CNullDriver
class SMaterial
{
public:
//! Default constructor. Creates a solid, lit material with white colors
SMaterial() :
MaterialType(EMT_SOLID), AmbientColor(255, 255, 255, 255),
@ -279,7 +273,8 @@ namespace video
GouraudShading(true), Lighting(true), ZWriteEnable(EZW_AUTO),
BackfaceCulling(true), FrontfaceCulling(false), FogEnable(false),
NormalizeNormals(false), UseMipMaps(true)
{ }
{
}
//! Texture layer array.
SMaterialLayer TextureLayers[MATERIAL_MAX_TEXTURES];
@ -348,7 +343,7 @@ namespace video
Only enabled color planes will be rendered to the current render
target. Typical use is to disable all colors when rendering only to
depth or stencil buffer, or using Red and Green for Stereo rendering. */
u8 ColorMask:4;
u8 ColorMask : 4;
//! Defines the interpretation of vertex color in the lighting equation
/** Values should be chosen from E_COLOR_MATERIAL.
@ -356,11 +351,11 @@ namespace video
material values for light modulation. This allows to easily change e.g. the
diffuse light behavior of each face. The default, ECM_DIFFUSE, will result in
a very similar rendering as with lighting turned off, just with light shading. */
u8 ColorMaterial:3;
u8 ColorMaterial : 3;
//! Store the blend operation of choice
/** Values to be chosen from E_BLEND_OPERATION. */
E_BLEND_OPERATION BlendOperation:4;
E_BLEND_OPERATION BlendOperation : 4;
//! Store the blend factors
/** textureBlendFunc/textureBlendFuncSeparate functions should be used to write
@ -393,44 +388,45 @@ namespace video
f32 PolygonOffsetSlopeScale;
//! Draw as wireframe or filled triangles? Default: false
bool Wireframe:1;
bool Wireframe : 1;
//! Draw as point cloud or filled triangles? Default: false
bool PointCloud:1;
bool PointCloud : 1;
//! Flat or Gouraud shading? Default: true
bool GouraudShading:1;
bool GouraudShading : 1;
//! Will this material be lighted? Default: true
bool Lighting:1;
bool Lighting : 1;
//! Is the zbuffer writable or is it read-only. Default: EZW_AUTO.
/** If this parameter is not EZW_OFF, you probably also want to set ZBuffer
to values other than ECFN_DISABLED */
E_ZWRITE ZWriteEnable:2;
E_ZWRITE ZWriteEnable : 2;
//! Is backface culling enabled? Default: true
bool BackfaceCulling:1;
bool BackfaceCulling : 1;
//! Is frontface culling enabled? Default: false
bool FrontfaceCulling:1;
bool FrontfaceCulling : 1;
//! Is fog enabled? Default: false
bool FogEnable:1;
bool FogEnable : 1;
//! Should normals be normalized?
/** Always use this if the mesh lit and scaled. Default: false */
bool NormalizeNormals:1;
bool NormalizeNormals : 1;
//! Shall mipmaps be used if available
/** Sometimes, disabling mipmap usage can be useful. Default: true */
bool UseMipMaps:1;
bool UseMipMaps : 1;
//! Execute a function on all texture layers.
/** Useful for setting properties which are not per material, but per
texture layer, e.g. bilinear filtering. */
template <typename F>
void forEachTexture(F &&fn) {
void forEachTexture(F &&fn)
{
for (u32 i = 0; i < MATERIAL_MAX_TEXTURES; i++) {
fn(TextureLayers[i]);
}
@ -439,7 +435,7 @@ namespace video
//! Gets the texture transformation matrix for level i
/** \param i The desired level. Must not be larger than MATERIAL_MAX_TEXTURES
\return Texture matrix for texture level i. */
core::matrix4& getTextureMatrix(u32 i)
core::matrix4 &getTextureMatrix(u32 i)
{
return TextureLayers[i].getTextureMatrix();
}
@ -447,9 +443,9 @@ namespace video
//! Gets the immutable texture transformation matrix for level i
/** \param i The desired level.
\return Texture matrix for texture level i, or identity matrix for levels larger than MATERIAL_MAX_TEXTURES. */
const core::matrix4& getTextureMatrix(u32 i) const
const core::matrix4 &getTextureMatrix(u32 i) const
{
if (i<MATERIAL_MAX_TEXTURES)
if (i < MATERIAL_MAX_TEXTURES)
return TextureLayers[i].getTextureMatrix();
else
return core::IdentityMatrix;
@ -458,9 +454,9 @@ namespace video
//! Sets the i-th texture transformation matrix
/** \param i The desired level.
\param mat Texture matrix for texture level i. */
void setTextureMatrix(u32 i, const core::matrix4& mat)
void setTextureMatrix(u32 i, const core::matrix4 &mat)
{
if (i>=MATERIAL_MAX_TEXTURES)
if (i >= MATERIAL_MAX_TEXTURES)
return;
TextureLayers[i].setTextureMatrix(mat);
}
@ -468,7 +464,7 @@ namespace video
//! Gets the i-th texture
/** \param i The desired level.
\return Texture for texture level i, if defined, else 0. */
ITexture* getTexture(u32 i) const
ITexture *getTexture(u32 i) const
{
return i < MATERIAL_MAX_TEXTURES ? TextureLayers[i].Texture : 0;
}
@ -477,9 +473,9 @@ namespace video
/** If i>=MATERIAL_MAX_TEXTURES this setting will be ignored.
\param i The desired level.
\param tex Texture for texture level i. */
void setTexture(u32 i, ITexture* tex)
void setTexture(u32 i, ITexture *tex)
{
if (i>=MATERIAL_MAX_TEXTURES)
if (i >= MATERIAL_MAX_TEXTURES)
return;
TextureLayers[i].Texture = tex;
}
@ -487,7 +483,7 @@ namespace video
//! Inequality operator
/** \param b Material to compare to.
\return True if the materials differ, else false. */
inline bool operator!=(const SMaterial& b) const
inline bool operator!=(const SMaterial &b) const
{
bool different =
MaterialType != b.MaterialType ||
@ -515,10 +511,8 @@ namespace video
BlendFactor != b.BlendFactor ||
PolygonOffsetDepthBias != b.PolygonOffsetDepthBias ||
PolygonOffsetSlopeScale != b.PolygonOffsetSlopeScale ||
UseMipMaps != b.UseMipMaps
;
for (u32 i=0; (i<MATERIAL_MAX_TEXTURES) && !different; ++i)
{
UseMipMaps != b.UseMipMaps;
for (u32 i = 0; (i < MATERIAL_MAX_TEXTURES) && !different; ++i) {
different |= (TextureLayers[i] != b.TextureLayers[i]);
}
return different;
@ -527,14 +521,15 @@ namespace video
//! Equality operator
/** \param b Material to compare to.
\return True if the materials are equal, else false. */
inline bool operator==(const SMaterial& b) const
{ return !(b!=*this); }
inline bool operator==(const SMaterial &b) const
{
return !(b != *this);
}
//! Check if material needs alpha blending
bool isAlphaBlendOperation() const
{
if (BlendOperation != EBO_NONE && BlendFactor != 0.f)
{
if (BlendOperation != EBO_NONE && BlendFactor != 0.f) {
E_BLEND_FACTOR srcRGBFact = EBF_ZERO;
E_BLEND_FACTOR dstRGBFact = EBF_ZERO;
E_BLEND_FACTOR srcAlphaFact = EBF_ZERO;
@ -545,8 +540,7 @@ namespace video
unpack_textureBlendFuncSeparate(srcRGBFact, dstRGBFact, srcAlphaFact, dstAlphaFact, modulo, alphaSource, BlendFactor);
if (textureBlendFunc_hasAlpha(srcRGBFact) || textureBlendFunc_hasAlpha(dstRGBFact) ||
textureBlendFunc_hasAlpha(srcAlphaFact) || textureBlendFunc_hasAlpha(dstAlphaFact))
{
textureBlendFunc_hasAlpha(srcAlphaFact) || textureBlendFunc_hasAlpha(dstAlphaFact)) {
return true;
}
}
@ -558,15 +552,15 @@ namespace video
//! as it asks the material renders directly what they do with the material.
bool isTransparent() const
{
if ( MaterialType==EMT_TRANSPARENT_ALPHA_CHANNEL ||
MaterialType==EMT_TRANSPARENT_VERTEX_ALPHA )
if (MaterialType == EMT_TRANSPARENT_ALPHA_CHANNEL ||
MaterialType == EMT_TRANSPARENT_VERTEX_ALPHA)
return true;
return false;
}
};
};
//! global const identity Material
IRRLICHT_API extern SMaterial IdentityMaterial;
//! global const identity Material
IRRLICHT_API extern SMaterial IdentityMaterial;
} // end namespace video
} // end namespace irr

110
include/SMaterialLayer.h
View File

@ -10,11 +10,11 @@ namespace irr
{
namespace video
{
class ITexture;
class ITexture;
//! Texture coord clamp mode outside [0.0, 1.0]
enum E_TEXTURE_CLAMP
{
//! Texture coord clamp mode outside [0.0, 1.0]
enum E_TEXTURE_CLAMP
{
//! Texture repeats
ETC_REPEAT = 0,
//! Texture is clamped to the last pixel
@ -31,8 +31,8 @@ namespace video
ETC_MIRROR_CLAMP_TO_EDGE,
//! Texture is mirrored once and then clamped to border
ETC_MIRROR_CLAMP_TO_BORDER
};
static const char* const aTextureClampNames[] = {
};
static const char *const aTextureClampNames[] = {
"texture_clamp_repeat",
"texture_clamp_clamp",
"texture_clamp_clamp_to_edge",
@ -42,11 +42,11 @@ namespace video
"texture_clamp_mirror_clamp_to_edge",
"texture_clamp_mirror_clamp_to_border", 0};
//! Texture minification filter.
/** Used when scaling textures down. See the documentation on OpenGL's
`GL_TEXTURE_MIN_FILTER` for more information. */
enum E_TEXTURE_MIN_FILTER {
//! Texture minification filter.
/** Used when scaling textures down. See the documentation on OpenGL's
`GL_TEXTURE_MIN_FILTER` for more information. */
enum E_TEXTURE_MIN_FILTER
{
//! Aka nearest-neighbor.
ETMINF_NEAREST_MIPMAP_NEAREST = 0,
//! Aka bilinear.
@ -55,33 +55,35 @@ namespace video
ETMINF_NEAREST_MIPMAP_LINEAR,
//! Aka trilinear.
ETMINF_LINEAR_MIPMAP_LINEAR,
};
};
//! Texture magnification filter.
/** Used when scaling textures up. See the documentation on OpenGL's
`GL_TEXTURE_MAG_FILTER` for more information.
Note that mipmaps are only used for minification, not for magnification. */
enum E_TEXTURE_MAG_FILTER {
//! Texture magnification filter.
/** Used when scaling textures up. See the documentation on OpenGL's
`GL_TEXTURE_MAG_FILTER` for more information.
Note that mipmaps are only used for minification, not for magnification. */
enum E_TEXTURE_MAG_FILTER
{
//! Aka nearest-neighbor.
ETMAGF_NEAREST = 0,
//! Aka bilinear.
ETMAGF_LINEAR,
};
};
//! Struct for holding material parameters which exist per texture layer
// Note for implementors: Serialization is in CNullDriver
class SMaterialLayer
{
public:
//! Struct for holding material parameters which exist per texture layer
// Note for implementors: Serialization is in CNullDriver
class SMaterialLayer
{
public:
//! Default constructor
SMaterialLayer() : Texture(0), TextureWrapU(ETC_REPEAT), TextureWrapV(ETC_REPEAT), TextureWrapW(ETC_REPEAT),
SMaterialLayer() :
Texture(0), TextureWrapU(ETC_REPEAT), TextureWrapV(ETC_REPEAT), TextureWrapW(ETC_REPEAT),
MinFilter(ETMINF_LINEAR_MIPMAP_NEAREST), MagFilter(ETMAGF_LINEAR), AnisotropicFilter(0), LODBias(0), TextureMatrix(0)
{
}
//! Copy constructor
/** \param other Material layer to copy from. */
SMaterialLayer(const SMaterialLayer& other)
SMaterialLayer(const SMaterialLayer &other)
{
// This pointer is checked during assignment
TextureMatrix = 0;
@ -91,8 +93,7 @@ namespace video
//! Destructor
~SMaterialLayer()
{
if ( TextureMatrix )
{
if (TextureMatrix) {
delete TextureMatrix;
}
}
@ -100,30 +101,24 @@ namespace video
//! Assignment operator
/** \param other Material layer to copy from.
\return This material layer, updated. */
SMaterialLayer& operator=(const SMaterialLayer& other)
SMaterialLayer &operator=(const SMaterialLayer &other)
{
// Check for self-assignment!
if (this == &other)
return *this;
Texture = other.Texture;
if (TextureMatrix)
{
if (TextureMatrix) {
if (other.TextureMatrix)
*TextureMatrix = *other.TextureMatrix;
else
{
else {
delete TextureMatrix;
TextureMatrix = 0;
}
}
else
{
if (other.TextureMatrix)
{
} else {
if (other.TextureMatrix) {
TextureMatrix = new core::matrix4(*other.TextureMatrix);
}
else
} else
TextureMatrix = 0;
}
TextureWrapU = other.TextureWrapU;
@ -139,10 +134,9 @@ namespace video
//! Gets the texture transformation matrix
/** \return Texture matrix of this layer. */
core::matrix4& getTextureMatrix()
{
if (!TextureMatrix)
core::matrix4 &getTextureMatrix()
{
if (!TextureMatrix) {
TextureMatrix = new core::matrix4();
}
return *TextureMatrix;
@ -150,7 +144,7 @@ namespace video
//! Gets the immutable texture transformation matrix
/** \return Texture matrix of this layer. */
const core::matrix4& getTextureMatrix() const
const core::matrix4 &getTextureMatrix() const
{
if (TextureMatrix)
return *TextureMatrix;
@ -162,20 +156,18 @@ namespace video
/** NOTE: Pipelines can ignore this matrix when the
texture is 0.
\param mat New texture matrix for this layer. */
void setTextureMatrix(const core::matrix4& mat)
{
if (!TextureMatrix)
void setTextureMatrix(const core::matrix4 &mat)
{
if (!TextureMatrix) {
TextureMatrix = new core::matrix4(mat);
}
else
} else
*TextureMatrix = mat;
}
//! Inequality operator
/** \param b Layer to compare to.
\return True if layers are different, else false. */
inline bool operator!=(const SMaterialLayer& b) const
inline bool operator!=(const SMaterialLayer &b) const
{
bool different =
Texture != b.Texture ||
@ -197,17 +189,19 @@ namespace video
//! Equality operator
/** \param b Layer to compare to.
\return True if layers are equal, else false. */
inline bool operator==(const SMaterialLayer& b) const
{ return !(b!=*this); }
inline bool operator==(const SMaterialLayer &b) const
{
return !(b != *this);
}
//! Texture
ITexture* Texture;
ITexture *Texture;
//! Texture Clamp Mode
/** Values are taken from E_TEXTURE_CLAMP. */
u8 TextureWrapU:4;
u8 TextureWrapV:4;
u8 TextureWrapW:4;
u8 TextureWrapU : 4;
u8 TextureWrapV : 4;
u8 TextureWrapW : 4;
//! Minification (downscaling) filter
E_TEXTURE_MIN_FILTER MinFilter;
@ -231,14 +225,14 @@ namespace video
if the value is positive. */
s8 LODBias;
private:
private:
friend class SMaterial;
//! Texture Matrix
/** Do not access this element directly as the internal
resource management has to cope with Null pointers etc. */
core::matrix4* TextureMatrix;
};
core::matrix4 *TextureMatrix;
};
} // end namespace video
} // end namespace irr

66
include/SMesh.h
View File

@ -13,35 +13,34 @@ namespace irr
{
namespace scene
{
//! Simple implementation of the IMesh interface.
struct SMesh : public IMesh
{
//! Simple implementation of the IMesh interface.
struct SMesh : public IMesh
{
//! constructor
SMesh()
{
#ifdef _DEBUG
#ifdef _DEBUG
setDebugName("SMesh");
#endif
#endif
}
//! destructor
virtual ~SMesh()
{
// drop buffers
for (u32 i=0; i<MeshBuffers.size(); ++i)
for (u32 i = 0; i < MeshBuffers.size(); ++i)
MeshBuffers[i]->drop();
}
//! clean mesh
virtual void clear()
{
for (u32 i=0; i<MeshBuffers.size(); ++i)
for (u32 i = 0; i < MeshBuffers.size(); ++i)
MeshBuffers[i]->drop();
MeshBuffers.clear();
BoundingBox.reset ( 0.f, 0.f, 0.f );
BoundingBox.reset(0.f, 0.f, 0.f);
}
//! returns amount of mesh buffers.
u32 getMeshBufferCount() const override
{
@ -49,18 +48,17 @@ namespace scene
}
//! returns pointer to a mesh buffer
IMeshBuffer* getMeshBuffer(u32 nr) const override
IMeshBuffer *getMeshBuffer(u32 nr) const override
{
return MeshBuffers[nr];
}
//! returns a meshbuffer which fits a material
/** reverse search */
IMeshBuffer* getMeshBuffer( const video::SMaterial & material) const override
IMeshBuffer *getMeshBuffer(const video::SMaterial &material) const override
{
for (s32 i = (s32)MeshBuffers.size()-1; i >= 0; --i)
{
if ( material == MeshBuffers[i]->getMaterial())
for (s32 i = (s32)MeshBuffers.size() - 1; i >= 0; --i) {
if (material == MeshBuffers[i]->getMaterial())
return MeshBuffers[i];
}
@ -68,13 +66,13 @@ namespace scene
}
//! returns an axis aligned bounding box
const core::aabbox3d<f32>& getBoundingBox() const override
const core::aabbox3d<f32> &getBoundingBox() const override
{
return BoundingBox;
}
//! set user axis aligned bounding box
void setBoundingBox( const core::aabbox3df& box) override
void setBoundingBox(const core::aabbox3df &box) override
{
BoundingBox = box;
}
@ -83,60 +81,52 @@ namespace scene
void recalculateBoundingBox()
{
bool hasMeshBufferBBox = false;
for (u32 i=0; i<MeshBuffers.size(); ++i)
{
const core::aabbox3df& bb = MeshBuffers[i]->getBoundingBox();
if ( !bb.isEmpty() )
{
if ( !hasMeshBufferBBox )
{
for (u32 i = 0; i < MeshBuffers.size(); ++i) {
const core::aabbox3df &bb = MeshBuffers[i]->getBoundingBox();
if (!bb.isEmpty()) {
if (!hasMeshBufferBBox) {
hasMeshBufferBBox = true;
BoundingBox = bb;
}
else
{
} else {
BoundingBox.addInternalBox(bb);
}
}
}
if ( !hasMeshBufferBBox )
if (!hasMeshBufferBBox)
BoundingBox.reset(0.0f, 0.0f, 0.0f);
}
//! adds a MeshBuffer
/** The bounding box is not updated automatically. */
void addMeshBuffer(IMeshBuffer* buf)
{
if (buf)
void addMeshBuffer(IMeshBuffer *buf)
{
if (buf) {
buf->grab();
MeshBuffers.push_back(buf);
}
}
//! set the hardware mapping hint, for driver
void setHardwareMappingHint( E_HARDWARE_MAPPING newMappingHint, E_BUFFER_TYPE buffer=EBT_VERTEX_AND_INDEX ) override
void setHardwareMappingHint(E_HARDWARE_MAPPING newMappingHint, E_BUFFER_TYPE buffer = EBT_VERTEX_AND_INDEX) override
{
for (u32 i=0; i<MeshBuffers.size(); ++i)
for (u32 i = 0; i < MeshBuffers.size(); ++i)
MeshBuffers[i]->setHardwareMappingHint(newMappingHint, buffer);
}
//! flags the meshbuffer as changed, reloads hardware buffers
void setDirty(E_BUFFER_TYPE buffer=EBT_VERTEX_AND_INDEX) override
void setDirty(E_BUFFER_TYPE buffer = EBT_VERTEX_AND_INDEX) override
{
for (u32 i=0; i<MeshBuffers.size(); ++i)
for (u32 i = 0; i < MeshBuffers.size(); ++i)
MeshBuffers[i]->setDirty(buffer);
}
//! The meshbuffers of this mesh
core::array<IMeshBuffer*> MeshBuffers;
core::array<IMeshBuffer *> MeshBuffers;
//! The bounding box of this mesh
core::aabbox3d<f32> BoundingBox;
};
};
} // end namespace scene
} // end namespace irr

1
include/SMeshBuffer.h
View File

@ -4,4 +4,3 @@
// replaced by template
#include "CMeshBuffer.h"

138
include/SOverrideMaterial.h
View File

@ -11,8 +11,8 @@ namespace irr
namespace video
{
struct SOverrideMaterial
{
struct SOverrideMaterial
{
//! The Material values
SMaterial Material;
@ -43,8 +43,10 @@ namespace video
struct SMaterialTypeReplacement
{
SMaterialTypeReplacement(s32 original, u32 replacement) : Original(original), Replacement(replacement) {}
SMaterialTypeReplacement(u32 replacement) : Original(-1), Replacement(replacement) {}
SMaterialTypeReplacement(s32 original, u32 replacement) :
Original(original), Replacement(replacement) {}
SMaterialTypeReplacement(u32 replacement) :
Original(-1), Replacement(replacement) {}
//! SMaterial.MaterialType to replace.
//! -1 for all types or a specific value to only replace that one (which is either one of E_MATERIAL_TYPE or a shader material id)
@ -58,7 +60,8 @@ namespace video
core::array<SMaterialTypeReplacement> MaterialTypes;
//! Default constructor
SOverrideMaterial() : EnableProps(0), EnablePasses(0), Enabled(false)
SOverrideMaterial() :
EnableProps(0), EnablePasses(0), Enabled(false)
{
}
@ -68,8 +71,7 @@ namespace video
EnableProps = 0;
EnablePasses = 0;
Enabled = false;
for (u32 i = 0; i < MATERIAL_MAX_TEXTURES; ++i)
{
for (u32 i = 0; i < MATERIAL_MAX_TEXTURES; ++i) {
EnableLayerProps[i] = true; // doesn't do anything unless EnableProps is set, just saying by default all texture layers are affected by properties
EnableTextures[i] = false;
EnableLayers[i] = false;
@ -78,77 +80,96 @@ namespace video
}
//! Apply the enabled overrides
void apply(SMaterial& material)
void apply(SMaterial &material)
{
if (Enabled)
{
for (u32 i = 0; i < MaterialTypes.size(); ++i)
{
const SMaterialTypeReplacement& mtr = MaterialTypes[i];
if (Enabled) {
for (u32 i = 0; i < MaterialTypes.size(); ++i) {
const SMaterialTypeReplacement &mtr = MaterialTypes[i];
if (mtr.Original < 0 || (s32)mtr.Original == material.MaterialType)
material.MaterialType = (E_MATERIAL_TYPE)mtr.Replacement;
}
for (u32 f=0; f<32; ++f)
{
const u32 num=(1<<f);
if (EnableProps & num)
{
switch (num)
{
case EMP_WIREFRAME: material.Wireframe = Material.Wireframe; break;
case EMP_POINTCLOUD: material.PointCloud = Material.PointCloud; break;
case EMP_GOURAUD_SHADING: material.GouraudShading = Material.GouraudShading; break;
case EMP_LIGHTING: material.Lighting = Material.Lighting; break;
case EMP_ZBUFFER: material.ZBuffer = Material.ZBuffer; break;
case EMP_ZWRITE_ENABLE: material.ZWriteEnable = Material.ZWriteEnable; break;
case EMP_BACK_FACE_CULLING: material.BackfaceCulling = Material.BackfaceCulling; break;
case EMP_FRONT_FACE_CULLING: material.FrontfaceCulling = Material.FrontfaceCulling; break;
for (u32 f = 0; f < 32; ++f) {
const u32 num = (1 << f);
if (EnableProps & num) {
switch (num) {
case EMP_WIREFRAME:
material.Wireframe = Material.Wireframe;
break;
case EMP_POINTCLOUD:
material.PointCloud = Material.PointCloud;
break;
case EMP_GOURAUD_SHADING:
material.GouraudShading = Material.GouraudShading;
break;
case EMP_LIGHTING:
material.Lighting = Material.Lighting;
break;
case EMP_ZBUFFER:
material.ZBuffer = Material.ZBuffer;
break;
case EMP_ZWRITE_ENABLE:
material.ZWriteEnable = Material.ZWriteEnable;
break;
case EMP_BACK_FACE_CULLING:
material.BackfaceCulling = Material.BackfaceCulling;
break;
case EMP_FRONT_FACE_CULLING:
material.FrontfaceCulling = Material.FrontfaceCulling;
break;
case EMP_MIN_FILTER:
for ( u32 i=0; i<MATERIAL_MAX_TEXTURES; ++i)
{
if ( EnableLayerProps[i] )
{
for (u32 i = 0; i < MATERIAL_MAX_TEXTURES; ++i) {
if (EnableLayerProps[i]) {
material.TextureLayers[i].MinFilter = Material.TextureLayers[i].MinFilter;
}
}
break;
case EMP_MAG_FILTER:
for ( u32 i=0; i<MATERIAL_MAX_TEXTURES; ++i)
{
if ( EnableLayerProps[i] )
{
for (u32 i = 0; i < MATERIAL_MAX_TEXTURES; ++i) {
if (EnableLayerProps[i]) {
material.TextureLayers[i].MagFilter = Material.TextureLayers[i].MagFilter;
}
}
break;
case EMP_ANISOTROPIC_FILTER:
for ( u32 i=0; i<MATERIAL_MAX_TEXTURES; ++i)
{
if ( EnableLayerProps[i] )
{
for (u32 i = 0; i < MATERIAL_MAX_TEXTURES; ++i) {
if (EnableLayerProps[i]) {
material.TextureLayers[i].AnisotropicFilter = Material.TextureLayers[i].AnisotropicFilter;
}
}
break;
case EMP_FOG_ENABLE: material.FogEnable = Material.FogEnable; break;
case EMP_NORMALIZE_NORMALS: material.NormalizeNormals = Material.NormalizeNormals; break;
case EMP_FOG_ENABLE:
material.FogEnable = Material.FogEnable;
break;
case EMP_NORMALIZE_NORMALS:
material.NormalizeNormals = Material.NormalizeNormals;
break;
case EMP_TEXTURE_WRAP:
for ( u32 i=0; i<MATERIAL_MAX_TEXTURES; ++i)
{
if ( EnableLayerProps[i] )
{
for (u32 i = 0; i < MATERIAL_MAX_TEXTURES; ++i) {
if (EnableLayerProps[i]) {
material.TextureLayers[i].TextureWrapU = Material.TextureLayers[i].TextureWrapU;
material.TextureLayers[i].TextureWrapV = Material.TextureLayers[i].TextureWrapV;
material.TextureLayers[i].TextureWrapW = Material.TextureLayers[i].TextureWrapW;
}
}
break;
case EMP_ANTI_ALIASING: material.AntiAliasing = Material.AntiAliasing; break;
case EMP_COLOR_MASK: material.ColorMask = Material.ColorMask; break;
case EMP_COLOR_MATERIAL: material.ColorMaterial = Material.ColorMaterial; break;
case EMP_USE_MIP_MAPS: material.UseMipMaps = Material.UseMipMaps; break;
case EMP_BLEND_OPERATION: material.BlendOperation = Material.BlendOperation; break;
case EMP_BLEND_FACTOR: material.BlendFactor = Material.BlendFactor; break;
case EMP_ANTI_ALIASING:
material.AntiAliasing = Material.AntiAliasing;
break;
case EMP_COLOR_MASK:
material.ColorMask = Material.ColorMask;
break;
case EMP_COLOR_MATERIAL:
material.ColorMaterial = Material.ColorMaterial;
break;
case EMP_USE_MIP_MAPS:
material.UseMipMaps = Material.UseMipMaps;
break;
case EMP_BLEND_OPERATION:
material.BlendOperation = Material.BlendOperation;
break;
case EMP_BLEND_FACTOR:
material.BlendFactor = Material.BlendFactor;
break;
case EMP_POLYGON_OFFSET:
material.PolygonOffsetDepthBias = Material.PolygonOffsetDepthBias;
material.PolygonOffsetSlopeScale = Material.PolygonOffsetSlopeScale;
@ -156,21 +177,16 @@ namespace video
}
}
}
for(u32 i=0; i<MATERIAL_MAX_TEXTURES; ++i )
{
if ( EnableLayers[i] )
{
for (u32 i = 0; i < MATERIAL_MAX_TEXTURES; ++i) {
if (EnableLayers[i]) {
material.TextureLayers[i] = Material.TextureLayers[i];
}
else if ( EnableTextures[i] )
{
} else if (EnableTextures[i]) {
material.TextureLayers[i].Texture = Material.TextureLayers[i].Texture;
}
}
}
}
};
};
} // end namespace video
} // end namespace irr

199
include/SSkinMeshBuffer.h
View File

@ -7,37 +7,35 @@
#include "IMeshBuffer.h"
#include "S3DVertex.h"
namespace irr
{
namespace scene
{
//! A mesh buffer able to choose between S3DVertex2TCoords, S3DVertex and S3DVertexTangents at runtime
struct SSkinMeshBuffer : public IMeshBuffer
{
//! Default constructor
SSkinMeshBuffer(video::E_VERTEX_TYPE vt=video::EVT_STANDARD) :
SSkinMeshBuffer(video::E_VERTEX_TYPE vt = video::EVT_STANDARD) :
ChangedID_Vertex(1), ChangedID_Index(1), VertexType(vt),
PrimitiveType(EPT_TRIANGLES),
MappingHint_Vertex(EHM_NEVER), MappingHint_Index(EHM_NEVER),
HWBuffer(NULL),
BoundingBoxNeedsRecalculated(true)
{
#ifdef _DEBUG
#ifdef _DEBUG
setDebugName("SSkinMeshBuffer");
#endif
#endif
}
//! Get Material of this buffer.
const video::SMaterial& getMaterial() const override
const video::SMaterial &getMaterial() const override
{
return Material;
}
//! Get Material of this buffer.
video::SMaterial& getMaterial() override
video::SMaterial &getMaterial() override
{
return Material;
}
@ -45,22 +43,20 @@ struct SSkinMeshBuffer : public IMeshBuffer
//! Get standard vertex at given index
virtual video::S3DVertex *getVertex(u32 index)
{
switch (VertexType)
{
switch (VertexType) {
case video::EVT_2TCOORDS:
return (video::S3DVertex*)&Vertices_2TCoords[index];
return (video::S3DVertex *)&Vertices_2TCoords[index];
case video::EVT_TANGENTS:
return (video::S3DVertex*)&Vertices_Tangents[index];
return (video::S3DVertex *)&Vertices_Tangents[index];
default:
return &Vertices_Standard[index];
}
}
//! Get pointer to vertex array
const void* getVertices() const override
{
switch (VertexType)
const void *getVertices() const override
{
switch (VertexType) {
case video::EVT_2TCOORDS:
return Vertices_2TCoords.const_pointer();
case video::EVT_TANGENTS:
@ -71,10 +67,9 @@ struct SSkinMeshBuffer : public IMeshBuffer
}
//! Get pointer to vertex array
void* getVertices() override
{
switch (VertexType)
void *getVertices() override
{
switch (VertexType) {
case video::EVT_2TCOORDS:
return Vertices_2TCoords.pointer();
case video::EVT_TANGENTS:
@ -87,8 +82,7 @@ struct SSkinMeshBuffer : public IMeshBuffer
//! Get vertex count
u32 getVertexCount() const override
{
switch (VertexType)
{
switch (VertexType) {
case video::EVT_2TCOORDS:
return Vertices_2TCoords.size();
case video::EVT_TANGENTS:
@ -106,13 +100,13 @@ struct SSkinMeshBuffer : public IMeshBuffer
}
//! Get pointer to index array
const u16* getIndices() const override
const u16 *getIndices() const override
{
return Indices.const_pointer();
}
//! Get pointer to index array
u16* getIndices() override
u16 *getIndices() override
{
return Indices.pointer();
}
@ -124,13 +118,13 @@ struct SSkinMeshBuffer : public IMeshBuffer
}
//! Get bounding box
const core::aabbox3d<f32>& getBoundingBox() const override
const core::aabbox3d<f32> &getBoundingBox() const override
{
return BoundingBox;
}
//! Set bounding box
void setBoundingBox( const core::aabbox3df& box) override
void setBoundingBox(const core::aabbox3df &box) override
{
BoundingBox = box;
}
@ -138,45 +132,38 @@ struct SSkinMeshBuffer : public IMeshBuffer
//! Recalculate bounding box
void recalculateBoundingBox() override
{
if(!BoundingBoxNeedsRecalculated)
if (!BoundingBoxNeedsRecalculated)
return;
BoundingBoxNeedsRecalculated = false;
switch (VertexType)
{
case video::EVT_STANDARD:
{
switch (VertexType) {
case video::EVT_STANDARD: {
if (Vertices_Standard.empty())
BoundingBox.reset(0,0,0);
else
{
BoundingBox.reset(0, 0, 0);
else {
BoundingBox.reset(Vertices_Standard[0].Pos);
for (u32 i=1; i<Vertices_Standard.size(); ++i)
for (u32 i = 1; i < Vertices_Standard.size(); ++i)
BoundingBox.addInternalPoint(Vertices_Standard[i].Pos);
}
break;
}
case video::EVT_2TCOORDS:
{
case video::EVT_2TCOORDS: {
if (Vertices_2TCoords.empty())
BoundingBox.reset(0,0,0);
else
{
BoundingBox.reset(0, 0, 0);
else {
BoundingBox.reset(Vertices_2TCoords[0].Pos);
for (u32 i=1; i<Vertices_2TCoords.size(); ++i)
for (u32 i = 1; i < Vertices_2TCoords.size(); ++i)
BoundingBox.addInternalPoint(Vertices_2TCoords[i].Pos);
}
break;
}
case video::EVT_TANGENTS:
{
case video::EVT_TANGENTS: {
if (Vertices_Tangents.empty())
BoundingBox.reset(0,0,0);
else
{
BoundingBox.reset(0, 0, 0);
else {
BoundingBox.reset(Vertices_Tangents[0].Pos);
for (u32 i=1; i<Vertices_Tangents.size(); ++i)
for (u32 i = 1; i < Vertices_Tangents.size(); ++i)
BoundingBox.addInternalPoint(Vertices_Tangents[i].Pos);
}
break;
@ -193,60 +180,52 @@ struct SSkinMeshBuffer : public IMeshBuffer
//! Convert to 2tcoords vertex type
void convertTo2TCoords()
{
if (VertexType==video::EVT_STANDARD)
{
for(u32 n=0;n<Vertices_Standard.size();++n)
{
if (VertexType == video::EVT_STANDARD) {
for (u32 n = 0; n < Vertices_Standard.size(); ++n) {
video::S3DVertex2TCoords Vertex;
Vertex.Color=Vertices_Standard[n].Color;
Vertex.Pos=Vertices_Standard[n].Pos;
Vertex.Normal=Vertices_Standard[n].Normal;
Vertex.TCoords=Vertices_Standard[n].TCoords;
Vertex.Color = Vertices_Standard[n].Color;
Vertex.Pos = Vertices_Standard[n].Pos;
Vertex.Normal = Vertices_Standard[n].Normal;
Vertex.TCoords = Vertices_Standard[n].TCoords;
Vertices_2TCoords.push_back(Vertex);
}
Vertices_Standard.clear();
VertexType=video::EVT_2TCOORDS;
VertexType = video::EVT_2TCOORDS;
}
}
//! Convert to tangents vertex type
void convertToTangents()
{
if (VertexType==video::EVT_STANDARD)
{
for(u32 n=0;n<Vertices_Standard.size();++n)
{
if (VertexType == video::EVT_STANDARD) {
for (u32 n = 0; n < Vertices_Standard.size(); ++n) {
video::S3DVertexTangents Vertex;
Vertex.Color=Vertices_Standard[n].Color;
Vertex.Pos=Vertices_Standard[n].Pos;
Vertex.Normal=Vertices_Standard[n].Normal;
Vertex.TCoords=Vertices_Standard[n].TCoords;
Vertex.Color = Vertices_Standard[n].Color;
Vertex.Pos = Vertices_Standard[n].Pos;
Vertex.Normal = Vertices_Standard[n].Normal;
Vertex.TCoords = Vertices_Standard[n].TCoords;
Vertices_Tangents.push_back(Vertex);
}
Vertices_Standard.clear();
VertexType=video::EVT_TANGENTS;
}
else if (VertexType==video::EVT_2TCOORDS)
{
for(u32 n=0;n<Vertices_2TCoords.size();++n)
{
VertexType = video::EVT_TANGENTS;
} else if (VertexType == video::EVT_2TCOORDS) {
for (u32 n = 0; n < Vertices_2TCoords.size(); ++n) {
video::S3DVertexTangents Vertex;
Vertex.Color=Vertices_2TCoords[n].Color;
Vertex.Pos=Vertices_2TCoords[n].Pos;
Vertex.Normal=Vertices_2TCoords[n].Normal;
Vertex.TCoords=Vertices_2TCoords[n].TCoords;
Vertex.Color = Vertices_2TCoords[n].Color;
Vertex.Pos = Vertices_2TCoords[n].Pos;
Vertex.Normal = Vertices_2TCoords[n].Normal;
Vertex.TCoords = Vertices_2TCoords[n].TCoords;
Vertices_Tangents.push_back(Vertex);
}
Vertices_2TCoords.clear();
VertexType=video::EVT_TANGENTS;
VertexType = video::EVT_TANGENTS;
}
}
//! returns position of vertex i
const core::vector3df& getPosition(u32 i) const override
{
switch (VertexType)
const core::vector3df &getPosition(u32 i) const override
{
switch (VertexType) {
case video::EVT_2TCOORDS:
return Vertices_2TCoords[i].Pos;
case video::EVT_TANGENTS:
@ -257,10 +236,9 @@ struct SSkinMeshBuffer : public IMeshBuffer
}
//! returns position of vertex i
core::vector3df& getPosition(u32 i) override
{
switch (VertexType)
core::vector3df &getPosition(u32 i) override
{
switch (VertexType) {
case video::EVT_2TCOORDS:
return Vertices_2TCoords[i].Pos;
case video::EVT_TANGENTS:
@ -271,10 +249,9 @@ struct SSkinMeshBuffer : public IMeshBuffer
}
//! returns normal of vertex i
const core::vector3df& getNormal(u32 i) const override
{
switch (VertexType)
const core::vector3df &getNormal(u32 i) const override
{
switch (VertexType) {
case video::EVT_2TCOORDS:
return Vertices_2TCoords[i].Normal;
case video::EVT_TANGENTS:
@ -285,10 +262,9 @@ struct SSkinMeshBuffer : public IMeshBuffer
}
//! returns normal of vertex i
core::vector3df& getNormal(u32 i) override
{
switch (VertexType)
core::vector3df &getNormal(u32 i) override
{
switch (VertexType) {
case video::EVT_2TCOORDS:
return Vertices_2TCoords[i].Normal;
case video::EVT_TANGENTS:
@ -299,10 +275,9 @@ struct SSkinMeshBuffer : public IMeshBuffer
}
//! returns texture coords of vertex i
const core::vector2df& getTCoords(u32 i) const override
{
switch (VertexType)
const core::vector2df &getTCoords(u32 i) const override
{
switch (VertexType) {
case video::EVT_2TCOORDS:
return Vertices_2TCoords[i].TCoords;
case video::EVT_TANGENTS:
@ -313,10 +288,9 @@ struct SSkinMeshBuffer : public IMeshBuffer
}
//! returns texture coords of vertex i
core::vector2df& getTCoords(u32 i) override
{
switch (VertexType)
core::vector2df &getTCoords(u32 i) override
{
switch (VertexType) {
case video::EVT_2TCOORDS:
return Vertices_2TCoords[i].TCoords;
case video::EVT_TANGENTS:
@ -327,7 +301,7 @@ struct SSkinMeshBuffer : public IMeshBuffer
}
//! append the vertices and indices to the current buffer
void append(const void* const vertices, u32 numVertices, const u16* const indices, u32 numIndices) override {}
void append(const void *const vertices, u32 numVertices, const u16 *const indices, u32 numIndices) override {}
//! get the current hardware mapping hint for vertex buffers
E_HARDWARE_MAPPING getHardwareMappingHint_Vertex() const override
@ -342,16 +316,15 @@ struct SSkinMeshBuffer : public IMeshBuffer
}
//! set the hardware mapping hint, for driver
void setHardwareMappingHint( E_HARDWARE_MAPPING NewMappingHint, E_BUFFER_TYPE Buffer=EBT_VERTEX_AND_INDEX ) override
void setHardwareMappingHint(E_HARDWARE_MAPPING NewMappingHint, E_BUFFER_TYPE Buffer = EBT_VERTEX_AND_INDEX) override
{
if (Buffer==EBT_VERTEX)
MappingHint_Vertex=NewMappingHint;
else if (Buffer==EBT_INDEX)
MappingHint_Index=NewMappingHint;
else if (Buffer==EBT_VERTEX_AND_INDEX)
{
MappingHint_Vertex=NewMappingHint;
MappingHint_Index=NewMappingHint;
if (Buffer == EBT_VERTEX)
MappingHint_Vertex = NewMappingHint;
else if (Buffer == EBT_INDEX)
MappingHint_Index = NewMappingHint;
else if (Buffer == EBT_VERTEX_AND_INDEX) {
MappingHint_Vertex = NewMappingHint;
MappingHint_Index = NewMappingHint;
}
}
@ -368,27 +341,28 @@ struct SSkinMeshBuffer : public IMeshBuffer
}
//! flags the mesh as changed, reloads hardware buffers
void setDirty(E_BUFFER_TYPE Buffer=EBT_VERTEX_AND_INDEX) override
void setDirty(E_BUFFER_TYPE Buffer = EBT_VERTEX_AND_INDEX) override
{
if (Buffer==EBT_VERTEX_AND_INDEX || Buffer==EBT_VERTEX)
if (Buffer == EBT_VERTEX_AND_INDEX || Buffer == EBT_VERTEX)
++ChangedID_Vertex;
if (Buffer==EBT_VERTEX_AND_INDEX || Buffer==EBT_INDEX)
if (Buffer == EBT_VERTEX_AND_INDEX || Buffer == EBT_INDEX)
++ChangedID_Index;
}
u32 getChangedID_Vertex() const override {return ChangedID_Vertex;}
u32 getChangedID_Vertex() const override { return ChangedID_Vertex; }
u32 getChangedID_Index() const override {return ChangedID_Index;}
u32 getChangedID_Index() const override { return ChangedID_Index; }
void setHWBuffer(void *ptr) const override {
void setHWBuffer(void *ptr) const override
{
HWBuffer = ptr;
}
void *getHWBuffer() const override {
void *getHWBuffer() const override
{
return HWBuffer;
}
//! Call this after changing the positions of any vertex.
void boundingBoxNeedsRecalculated(void) { BoundingBoxNeedsRecalculated = true; }
@ -400,7 +374,7 @@ struct SSkinMeshBuffer : public IMeshBuffer
u32 ChangedID_Vertex;
u32 ChangedID_Index;
//ISkinnedMesh::SJoint *AttachedJoint;
// ISkinnedMesh::SJoint *AttachedJoint;
core::matrix4 Transformation;
video::SMaterial Material;
@ -412,14 +386,13 @@ struct SSkinMeshBuffer : public IMeshBuffer
E_PRIMITIVE_TYPE PrimitiveType;
// hardware mapping hint
E_HARDWARE_MAPPING MappingHint_Vertex:3;
E_HARDWARE_MAPPING MappingHint_Index:3;
E_HARDWARE_MAPPING MappingHint_Vertex : 3;
E_HARDWARE_MAPPING MappingHint_Index : 3;
mutable void *HWBuffer;
bool BoundingBoxNeedsRecalculated:1;
bool BoundingBoxNeedsRecalculated : 1;
};
} // end namespace scene
} // end namespace irr

2
include/SVertexIndex.h
View File

@ -6,7 +6,6 @@
#include "irrTypes.h"
namespace irr
{
namespace video
@ -17,6 +16,5 @@ enum E_INDEX_TYPE
EIT_32BIT
};
} // end namespace video
} // end namespace irr

34
include/SVertexManipulator.h
View File

@ -13,30 +13,32 @@ namespace irr
namespace scene
{
class IMesh;
class IMeshBuffer;
struct SMesh;
class IMesh;
class IMeshBuffer;
struct SMesh;
//! Interface for vertex manipulators.
/** You should derive your manipulator from this class if it shall be called for every vertex, getting as parameter just the vertex.
//! Interface for vertex manipulators.
/** You should derive your manipulator from this class if it shall be called for every vertex, getting as parameter just the vertex.
*/
struct IVertexManipulator
{
};
struct IVertexManipulator
{
};
//! Vertex manipulator which scales the position of the vertex
class SVertexPositionScaleManipulator : public IVertexManipulator
{
public:
SVertexPositionScaleManipulator(const core::vector3df& factor) : Factor(factor) {}
//! Vertex manipulator which scales the position of the vertex
class SVertexPositionScaleManipulator : public IVertexManipulator
{
public:
SVertexPositionScaleManipulator(const core::vector3df &factor) :
Factor(factor) {}
template <typename VType>
void operator()(VType& vertex) const
void operator()(VType &vertex) const
{
vertex.Pos *= Factor;
}
private:
private:
core::vector3df Factor;
};
};
} // end namespace scene
} // end namespace irr

273
include/SViewFrustum.h
View File

@ -16,13 +16,13 @@ namespace irr
namespace scene
{
//! Defines the view frustum. That's the space visible by the camera.
/** The view frustum is enclosed by 6 planes. These six planes share
eight points. A bounding box around these eight points is also stored in
this structure.
*/
struct SViewFrustum
{
//! Defines the view frustum. That's the space visible by the camera.
/** The view frustum is enclosed by 6 planes. These six planes share
eight points. A bounding box around these eight points is also stored in
this structure.
*/
struct SViewFrustum
{
enum VFPLANES
{
//! Far plane of the frustum. That is the plane furthest away from the eye.
@ -42,24 +42,24 @@ namespace scene
VF_PLANE_COUNT
};
//! Default Constructor
SViewFrustum() : BoundingRadius(0.f), FarNearDistance(0.f) {}
SViewFrustum() :
BoundingRadius(0.f), FarNearDistance(0.f) {}
//! Copy Constructor
SViewFrustum(const SViewFrustum& other);
SViewFrustum(const SViewFrustum &other);
//! This constructor creates a view frustum based on a projection and/or view matrix.
//\param zClipFromZero: Clipping of z can be projected from 0 to w when true (D3D style) and from -w to w when false (OGL style).
SViewFrustum(const core::matrix4& mat, bool zClipFromZero);
SViewFrustum(const core::matrix4 &mat, bool zClipFromZero);
//! This constructor creates a view frustum based on a projection and/or view matrix.
//\param zClipFromZero: Clipping of z can be projected from 0 to w when true (D3D style) and from -w to w when false (OGL style).
inline void setFrom(const core::matrix4& mat, bool zClipFromZero);
inline void setFrom(const core::matrix4 &mat, bool zClipFromZero);
//! transforms the frustum by the matrix
/** \param mat: Matrix by which the view frustum is transformed.*/
void transform(const core::matrix4& mat);
void transform(const core::matrix4 &mat);
//! returns the point which is on the far left upper corner inside the the view frustum.
core::vector3df getFarLeftUp() const;
@ -101,14 +101,14 @@ namespace scene
void setFarNearDistance(float distance);
//! get the given state's matrix based on frustum E_TRANSFORMATION_STATE
core::matrix4& getTransform( video::E_TRANSFORMATION_STATE state);
core::matrix4 &getTransform(video::E_TRANSFORMATION_STATE state);
//! get the given state's matrix based on frustum E_TRANSFORMATION_STATE
const core::matrix4& getTransform( video::E_TRANSFORMATION_STATE state) const;
const core::matrix4 &getTransform(video::E_TRANSFORMATION_STATE state) const;
//! clips a line to the view frustum.
/** \return True if the line was clipped, false if not */
bool clipLine(core::line3d<f32>& line) const;
bool clipLine(core::line3d<f32> &line) const;
//! the position of the camera
core::vector3df cameraPosition;
@ -119,7 +119,7 @@ namespace scene
//! bounding box around the view frustum
core::aabbox3d<f32> boundingBox;
private:
private:
//! Hold a copy of important transform matrices
enum E_TRANSFORMATION_STATE_FRUSTUM
{
@ -137,132 +137,129 @@ namespace scene
float BoundingRadius;
float FarNearDistance;
core::vector3df BoundingCenter;
};
};
/*!
/*!
Copy constructor ViewFrustum
*/
inline SViewFrustum::SViewFrustum(const SViewFrustum& other)
{
cameraPosition=other.cameraPosition;
boundingBox=other.boundingBox;
*/
inline SViewFrustum::SViewFrustum(const SViewFrustum &other)
{
cameraPosition = other.cameraPosition;
boundingBox = other.boundingBox;
u32 i;
for (i=0; i<VF_PLANE_COUNT; ++i)
planes[i]=other.planes[i];
for (i = 0; i < VF_PLANE_COUNT; ++i)
planes[i] = other.planes[i];
for (i=0; i<ETS_COUNT_FRUSTUM; ++i)
Matrices[i]=other.Matrices[i];
for (i = 0; i < ETS_COUNT_FRUSTUM; ++i)
Matrices[i] = other.Matrices[i];
BoundingRadius = other.BoundingRadius;
FarNearDistance = other.FarNearDistance;
BoundingCenter = other.BoundingCenter;
}
}
inline SViewFrustum::SViewFrustum(const core::matrix4& mat, bool zClipFromZero)
{
inline SViewFrustum::SViewFrustum(const core::matrix4 &mat, bool zClipFromZero)
{
setFrom(mat, zClipFromZero);
}
}
inline void SViewFrustum::transform(const core::matrix4& mat)
{
for (u32 i=0; i<VF_PLANE_COUNT; ++i)
inline void SViewFrustum::transform(const core::matrix4 &mat)
{
for (u32 i = 0; i < VF_PLANE_COUNT; ++i)
mat.transformPlane(planes[i]);
mat.transformVect(cameraPosition);
recalculateBoundingBox();
}
}
inline core::vector3df SViewFrustum::getFarLeftUp() const
{
inline core::vector3df SViewFrustum::getFarLeftUp() const
{
core::vector3df p;
planes[scene::SViewFrustum::VF_FAR_PLANE].getIntersectionWithPlanes(
planes[scene::SViewFrustum::VF_TOP_PLANE],
planes[scene::SViewFrustum::VF_LEFT_PLANE], p);
return p;
}
}
inline core::vector3df SViewFrustum::getFarLeftDown() const
{
inline core::vector3df SViewFrustum::getFarLeftDown() const
{
core::vector3df p;
planes[scene::SViewFrustum::VF_FAR_PLANE].getIntersectionWithPlanes(
planes[scene::SViewFrustum::VF_BOTTOM_PLANE],
planes[scene::SViewFrustum::VF_LEFT_PLANE], p);
return p;
}
}
inline core::vector3df SViewFrustum::getFarRightUp() const
{
inline core::vector3df SViewFrustum::getFarRightUp() const
{
core::vector3df p;
planes[scene::SViewFrustum::VF_FAR_PLANE].getIntersectionWithPlanes(
planes[scene::SViewFrustum::VF_TOP_PLANE],
planes[scene::SViewFrustum::VF_RIGHT_PLANE], p);
return p;
}
}
inline core::vector3df SViewFrustum::getFarRightDown() const
{
inline core::vector3df SViewFrustum::getFarRightDown() const
{
core::vector3df p;
planes[scene::SViewFrustum::VF_FAR_PLANE].getIntersectionWithPlanes(
planes[scene::SViewFrustum::VF_BOTTOM_PLANE],
planes[scene::SViewFrustum::VF_RIGHT_PLANE], p);
return p;
}
}
inline core::vector3df SViewFrustum::getNearLeftUp() const
{
inline core::vector3df SViewFrustum::getNearLeftUp() const
{
core::vector3df p;
planes[scene::SViewFrustum::VF_NEAR_PLANE].getIntersectionWithPlanes(
planes[scene::SViewFrustum::VF_TOP_PLANE],
planes[scene::SViewFrustum::VF_LEFT_PLANE], p);
return p;
}
}
inline core::vector3df SViewFrustum::getNearLeftDown() const
{
inline core::vector3df SViewFrustum::getNearLeftDown() const
{
core::vector3df p;
planes[scene::SViewFrustum::VF_NEAR_PLANE].getIntersectionWithPlanes(
planes[scene::SViewFrustum::VF_BOTTOM_PLANE],
planes[scene::SViewFrustum::VF_LEFT_PLANE], p);
return p;
}
}
inline core::vector3df SViewFrustum::getNearRightUp() const
{
inline core::vector3df SViewFrustum::getNearRightUp() const
{
core::vector3df p;
planes[scene::SViewFrustum::VF_NEAR_PLANE].getIntersectionWithPlanes(
planes[scene::SViewFrustum::VF_TOP_PLANE],
planes[scene::SViewFrustum::VF_RIGHT_PLANE], p);
return p;
}
}
inline core::vector3df SViewFrustum::getNearRightDown() const
{
inline core::vector3df SViewFrustum::getNearRightDown() const
{
core::vector3df p;
planes[scene::SViewFrustum::VF_NEAR_PLANE].getIntersectionWithPlanes(
planes[scene::SViewFrustum::VF_BOTTOM_PLANE],
planes[scene::SViewFrustum::VF_RIGHT_PLANE], p);
return p;
}
}
inline const core::aabbox3d<f32> &SViewFrustum::getBoundingBox() const
{
inline const core::aabbox3d<f32> &SViewFrustum::getBoundingBox() const
{
return boundingBox;
}
}
inline void SViewFrustum::recalculateBoundingBox()
{
inline void SViewFrustum::recalculateBoundingBox()
{
boundingBox.reset(getNearLeftUp());
boundingBox.addInternalPoint(getNearRightUp());
boundingBox.addInternalPoint(getNearLeftDown());
@ -274,78 +271,74 @@ namespace scene
// Also recalculate the bounding sphere when the bbox changes
recalculateBoundingSphere();
}
}
inline float SViewFrustum::getBoundingRadius() const
{
inline float SViewFrustum::getBoundingRadius() const
{
return BoundingRadius;
}
}
inline core::vector3df SViewFrustum::getBoundingCenter() const
{
inline core::vector3df SViewFrustum::getBoundingCenter() const
{
return BoundingCenter;
}
}
inline void SViewFrustum::setFarNearDistance(float distance)
{
inline void SViewFrustum::setFarNearDistance(float distance)
{
FarNearDistance = distance;
}
}
//! This constructor creates a view frustum based on a projection
//! and/or view matrix.
inline void SViewFrustum::setFrom(const core::matrix4& mat, bool zClipFromZero)
{
//! This constructor creates a view frustum based on a projection
//! and/or view matrix.
inline void SViewFrustum::setFrom(const core::matrix4 &mat, bool zClipFromZero)
{
// left clipping plane
planes[VF_LEFT_PLANE].Normal.X = mat[3 ] + mat[0];
planes[VF_LEFT_PLANE].Normal.Y = mat[7 ] + mat[4];
planes[VF_LEFT_PLANE].Normal.X = mat[3] + mat[0];
planes[VF_LEFT_PLANE].Normal.Y = mat[7] + mat[4];
planes[VF_LEFT_PLANE].Normal.Z = mat[11] + mat[8];
planes[VF_LEFT_PLANE].D = mat[15] + mat[12];
// right clipping plane
planes[VF_RIGHT_PLANE].Normal.X = mat[3 ] - mat[0];
planes[VF_RIGHT_PLANE].Normal.Y = mat[7 ] - mat[4];
planes[VF_RIGHT_PLANE].Normal.X = mat[3] - mat[0];
planes[VF_RIGHT_PLANE].Normal.Y = mat[7] - mat[4];
planes[VF_RIGHT_PLANE].Normal.Z = mat[11] - mat[8];
planes[VF_RIGHT_PLANE].D = mat[15] - mat[12];
// top clipping plane
planes[VF_TOP_PLANE].Normal.X = mat[3 ] - mat[1];
planes[VF_TOP_PLANE].Normal.Y = mat[7 ] - mat[5];
planes[VF_TOP_PLANE].Normal.X = mat[3] - mat[1];
planes[VF_TOP_PLANE].Normal.Y = mat[7] - mat[5];
planes[VF_TOP_PLANE].Normal.Z = mat[11] - mat[9];
planes[VF_TOP_PLANE].D = mat[15] - mat[13];
// bottom clipping plane
planes[VF_BOTTOM_PLANE].Normal.X = mat[3 ] + mat[1];
planes[VF_BOTTOM_PLANE].Normal.Y = mat[7 ] + mat[5];
planes[VF_BOTTOM_PLANE].Normal.X = mat[3] + mat[1];
planes[VF_BOTTOM_PLANE].Normal.Y = mat[7] + mat[5];
planes[VF_BOTTOM_PLANE].Normal.Z = mat[11] + mat[9];
planes[VF_BOTTOM_PLANE].D = mat[15] + mat[13];
// far clipping plane
planes[VF_FAR_PLANE].Normal.X = mat[3 ] - mat[2];
planes[VF_FAR_PLANE].Normal.Y = mat[7 ] - mat[6];
planes[VF_FAR_PLANE].Normal.X = mat[3] - mat[2];
planes[VF_FAR_PLANE].Normal.Y = mat[7] - mat[6];
planes[VF_FAR_PLANE].Normal.Z = mat[11] - mat[10];
planes[VF_FAR_PLANE].D = mat[15] - mat[14];
// near clipping plane
if ( zClipFromZero )
{
if (zClipFromZero) {
planes[VF_NEAR_PLANE].Normal.X = mat[2];
planes[VF_NEAR_PLANE].Normal.Y = mat[6];
planes[VF_NEAR_PLANE].Normal.Z = mat[10];
planes[VF_NEAR_PLANE].D = mat[14];
}
else
{
} else {
// near clipping plane
planes[VF_NEAR_PLANE].Normal.X = mat[3 ] + mat[2];
planes[VF_NEAR_PLANE].Normal.Y = mat[7 ] + mat[6];
planes[VF_NEAR_PLANE].Normal.X = mat[3] + mat[2];
planes[VF_NEAR_PLANE].Normal.Y = mat[7] + mat[6];
planes[VF_NEAR_PLANE].Normal.Z = mat[11] + mat[10];
planes[VF_NEAR_PLANE].D = mat[15] + mat[14];
}
// normalize normals
u32 i;
for ( i=0; i != VF_PLANE_COUNT; ++i)
{
for (i = 0; i != VF_PLANE_COUNT; ++i) {
const f32 len = -core::reciprocal_squareroot(
planes[i].Normal.getLengthSQ());
planes[i].Normal *= len;
@ -354,74 +347,73 @@ namespace scene
// make bounding box
recalculateBoundingBox();
}
}
/*!
/*!
View Frustum depends on Projection & View Matrix
*/
inline core::matrix4& SViewFrustum::getTransform(video::E_TRANSFORMATION_STATE state)
{
*/
inline core::matrix4 &SViewFrustum::getTransform(video::E_TRANSFORMATION_STATE state)
{
u32 index = 0;
switch ( state )
{
switch (state) {
case video::ETS_PROJECTION:
index = SViewFrustum::ETS_PROJECTION; break;
index = SViewFrustum::ETS_PROJECTION;
break;
case video::ETS_VIEW:
index = SViewFrustum::ETS_VIEW; break;
index = SViewFrustum::ETS_VIEW;
break;
default:
break;
}
return Matrices [ index ];
}
return Matrices[index];
}
/*!
/*!
View Frustum depends on Projection & View Matrix
*/
inline const core::matrix4& SViewFrustum::getTransform(video::E_TRANSFORMATION_STATE state) const
{
*/
inline const core::matrix4 &SViewFrustum::getTransform(video::E_TRANSFORMATION_STATE state) const
{
u32 index = 0;
switch ( state )
{
switch (state) {
case video::ETS_PROJECTION:
index = SViewFrustum::ETS_PROJECTION; break;
index = SViewFrustum::ETS_PROJECTION;
break;
case video::ETS_VIEW:
index = SViewFrustum::ETS_VIEW; break;
index = SViewFrustum::ETS_VIEW;
break;
default:
break;
}
return Matrices [ index ];
}
return Matrices[index];
}
//! Clips a line to the frustum
inline bool SViewFrustum::clipLine(core::line3d<f32>& line) const
{
//! Clips a line to the frustum
inline bool SViewFrustum::clipLine(core::line3d<f32> &line) const
{
bool wasClipped = false;
for (u32 i=0; i < VF_PLANE_COUNT; ++i)
{
if (planes[i].classifyPointRelation(line.start) == core::ISREL3D_FRONT)
{
for (u32 i = 0; i < VF_PLANE_COUNT; ++i) {
if (planes[i].classifyPointRelation(line.start) == core::ISREL3D_FRONT) {
line.start = line.start.getInterpolated(line.end,
1.f-planes[i].getKnownIntersectionWithLine(line.start, line.end));
1.f - planes[i].getKnownIntersectionWithLine(line.start, line.end));
wasClipped = true;
}
if (planes[i].classifyPointRelation(line.end) == core::ISREL3D_FRONT)
{
if (planes[i].classifyPointRelation(line.end) == core::ISREL3D_FRONT) {
line.end = line.start.getInterpolated(line.end,
1.f-planes[i].getKnownIntersectionWithLine(line.start, line.end));
1.f - planes[i].getKnownIntersectionWithLine(line.start, line.end));
wasClipped = true;
}
}
return wasClipped;
}
}
inline void SViewFrustum::recalculateBoundingSphere()
{
inline void SViewFrustum::recalculateBoundingSphere()
{
// Find the center
const float shortlen = (getNearLeftUp() - getNearRightUp()).getLength();
const float longlen = (getFarLeftUp() - getFarRightUp()).getLength();
const float farlen = FarNearDistance;
const float fartocenter = (farlen + (shortlen - longlen) * (shortlen + longlen)/(4*farlen)) / 2;
const float fartocenter = (farlen + (shortlen - longlen) * (shortlen + longlen) / (4 * farlen)) / 2;
const float neartocenter = farlen - fartocenter;
BoundingCenter = cameraPosition + -planes[VF_NEAR_PLANE].Normal * neartocenter;
@ -438,21 +430,20 @@ namespace scene
dir[7] = getNearLeftUp() - BoundingCenter;
u32 i = 0;
float diam[8] = { 0.f };
float diam[8] = {0.f};
for (i = 0; i < 8; ++i)
diam[i] = dir[i].getLengthSQ();
float longest = 0;
for (i = 0; i < 8; ++i)
{
for (i = 0; i < 8; ++i) {
if (diam[i] > longest)
longest = diam[i];
}
BoundingRadius = sqrtf(longest);
}
}
} // end namespace scene
} // end namespace irr

53
include/SceneParameters.h
View File

@ -17,35 +17,34 @@ namespace irr
{
namespace scene
{
//! Name of the parameter for changing how Irrlicht handles the ZWrite flag for transparent (blending) materials
/** The default behavior in Irrlicht is to disable writing to the
z-buffer for all really transparent, i.e. blending materials. This
avoids problems with intersecting faces, but can also break renderings.
If transparent materials should use the SMaterial flag for ZWriteEnable
just as other material types use this attribute.
Use it like this:
\code
SceneManager->getParameters()->setAttribute(scene::ALLOW_ZWRITE_ON_TRANSPARENT, true);
\endcode
**/
const c8* const ALLOW_ZWRITE_ON_TRANSPARENT = "Allow_ZWrite_On_Transparent";
//! Name of the parameter for changing how Irrlicht handles the ZWrite flag for transparent (blending) materials
/** The default behavior in Irrlicht is to disable writing to the
z-buffer for all really transparent, i.e. blending materials. This
avoids problems with intersecting faces, but can also break renderings.
If transparent materials should use the SMaterial flag for ZWriteEnable
just as other material types use this attribute.
Use it like this:
\code
SceneManager->getParameters()->setAttribute(scene::ALLOW_ZWRITE_ON_TRANSPARENT, true);
\endcode
**/
const c8 *const ALLOW_ZWRITE_ON_TRANSPARENT = "Allow_ZWrite_On_Transparent";
//! Flag to avoid loading group structures in .obj files
/** Use it like this:
\code
SceneManager->getParameters()->setAttribute(scene::OBJ_LOADER_IGNORE_GROUPS, true);
\endcode
**/
const c8* const OBJ_LOADER_IGNORE_GROUPS = "OBJ_IgnoreGroups";
//! Flag to avoid loading group structures in .obj files
/** Use it like this:
\code
SceneManager->getParameters()->setAttribute(scene::OBJ_LOADER_IGNORE_GROUPS, true);
\endcode
**/
const c8 *const OBJ_LOADER_IGNORE_GROUPS = "OBJ_IgnoreGroups";
//! Flag to avoid loading material .mtl file for .obj files
/** Use it like this:
\code
SceneManager->getParameters()->setAttribute(scene::OBJ_LOADER_IGNORE_MATERIAL_FILES, true);
\endcode
**/
const c8* const OBJ_LOADER_IGNORE_MATERIAL_FILES = "OBJ_IgnoreMaterialFiles";
//! Flag to avoid loading material .mtl file for .obj files
/** Use it like this:
\code
SceneManager->getParameters()->setAttribute(scene::OBJ_LOADER_IGNORE_MATERIAL_FILES, true);
\endcode
**/
const c8 *const OBJ_LOADER_IGNORE_MATERIAL_FILES = "OBJ_IgnoreMaterialFiles";
} // end namespace scene
} // end namespace irr

139
include/aabbox3d.h
View File

@ -15,33 +15,39 @@ namespace core
//! Axis aligned bounding box in 3d dimensional space.
/** Has some useful methods used with occlusion culling or clipping.
*/
*/
template <class T>
class aabbox3d
{
public:
public:
//! Default Constructor.
constexpr aabbox3d(): MinEdge(-1,-1,-1), MaxEdge(1,1,1) {}
constexpr aabbox3d() :
MinEdge(-1, -1, -1), MaxEdge(1, 1, 1) {}
//! Constructor with min edge and max edge.
constexpr aabbox3d(const vector3d<T>& min, const vector3d<T>& max): MinEdge(min), MaxEdge(max) {}
constexpr aabbox3d(const vector3d<T> &min, const vector3d<T> &max) :
MinEdge(min), MaxEdge(max) {}
//! Constructor with only one point.
constexpr aabbox3d(const vector3d<T>& init): MinEdge(init), MaxEdge(init) {}
constexpr aabbox3d(const vector3d<T> &init) :
MinEdge(init), MaxEdge(init) {}
//! Constructor with min edge and max edge as single values, not vectors.
constexpr aabbox3d(T minx, T miny, T minz, T maxx, T maxy, T maxz):
constexpr aabbox3d(T minx, T miny, T minz, T maxx, T maxy, T maxz) :
MinEdge(minx, miny, minz), MaxEdge(maxx, maxy, maxz) {}
// operators
//! Equality operator
/** \param other box to compare with.
\return True if both boxes are equal, else false. */
constexpr inline bool operator==(const aabbox3d<T>& other) const
{ return (MinEdge == other.MinEdge && other.MaxEdge == MaxEdge); }
constexpr inline bool operator==(const aabbox3d<T> &other) const
{
return (MinEdge == other.MinEdge && other.MaxEdge == MaxEdge);
}
//! Inequality operator
/** \param other box to compare with.
\return True if both boxes are different, else false. */
constexpr inline bool operator!=(const aabbox3d<T>& other) const
{ return !(MinEdge == other.MinEdge && other.MaxEdge == MaxEdge); }
constexpr inline bool operator!=(const aabbox3d<T> &other) const
{
return !(MinEdge == other.MinEdge && other.MaxEdge == MaxEdge);
}
// functions
@ -51,20 +57,20 @@ class aabbox3d
\param z Z coord of the point. */
void reset(T x, T y, T z)
{
MaxEdge.set(x,y,z);
MaxEdge.set(x, y, z);
MinEdge = MaxEdge;
}
//! Resets the bounding box.
/** \param initValue New box to set this one to. */
void reset(const aabbox3d<T>& initValue)
void reset(const aabbox3d<T> &initValue)
{
*this = initValue;
}
//! Resets the bounding box to a one-point box.
/** \param initValue New point. */
void reset(const vector3d<T>& initValue)
void reset(const vector3d<T> &initValue)
{
MaxEdge = initValue;
MinEdge = initValue;
@ -73,7 +79,7 @@ class aabbox3d
//! Adds a point to the bounding box
/** The box grows bigger, if point was outside of the box.
\param p: Point to add into the box. */
void addInternalPoint(const vector3d<T>& p)
void addInternalPoint(const vector3d<T> &p)
{
addInternalPoint(p.X, p.Y, p.Z);
}
@ -81,7 +87,7 @@ class aabbox3d
//! Adds another bounding box
/** The box grows bigger, if the new box was outside of the box.
\param b: Other bounding box to add into this box. */
void addInternalBox(const aabbox3d<T>& b)
void addInternalBox(const aabbox3d<T> &b)
{
addInternalPoint(b.MaxEdge);
addInternalPoint(b.MinEdge);
@ -94,13 +100,19 @@ class aabbox3d
\param z Z coordinate of the point to add to this box. */
void addInternalPoint(T x, T y, T z)
{
if (x>MaxEdge.X) MaxEdge.X = x;
if (y>MaxEdge.Y) MaxEdge.Y = y;
if (z>MaxEdge.Z) MaxEdge.Z = z;
if (x > MaxEdge.X)
MaxEdge.X = x;
if (y > MaxEdge.Y)
MaxEdge.Y = y;
if (z > MaxEdge.Z)
MaxEdge.Z = z;
if (x<MinEdge.X) MinEdge.X = x;
if (y<MinEdge.Y) MinEdge.Y = y;
if (z<MinEdge.Z) MinEdge.Z = z;
if (x < MinEdge.X)
MinEdge.X = x;
if (y < MinEdge.Y)
MinEdge.Y = y;
if (z < MinEdge.Z)
MinEdge.Z = z;
}
//! Get center of the bounding box
@ -130,7 +142,7 @@ class aabbox3d
\return True if box is empty, else false. */
bool isEmpty() const
{
return MinEdge.equals ( MaxEdge );
return MinEdge.equals(MaxEdge);
}
//! Get the volume enclosed by the box in cubed units
@ -144,7 +156,7 @@ class aabbox3d
T getArea() const
{
const vector3d<T> e = getExtent();
return 2*(e.X*e.Y + e.X*e.Z + e.Y*e.Z);
return 2 * (e.X * e.Y + e.X * e.Z + e.Y * e.Z);
}
//! Stores all 8 edges of the box into an array
@ -183,20 +195,32 @@ class aabbox3d
{
T t;
if (MinEdge.X > MaxEdge.X)
{ t=MinEdge.X; MinEdge.X = MaxEdge.X; MaxEdge.X=t; }
if (MinEdge.Y > MaxEdge.Y)
{ t=MinEdge.Y; MinEdge.Y = MaxEdge.Y; MaxEdge.Y=t; }
if (MinEdge.Z > MaxEdge.Z)
{ t=MinEdge.Z; MinEdge.Z = MaxEdge.Z; MaxEdge.Z=t; }
if (MinEdge.X > MaxEdge.X) {
t = MinEdge.X;
MinEdge.X = MaxEdge.X;
MaxEdge.X = t;
}
if (MinEdge.Y > MaxEdge.Y) {
t = MinEdge.Y;
MinEdge.Y = MaxEdge.Y;
MaxEdge.Y = t;
}
if (MinEdge.Z > MaxEdge.Z) {
t = MinEdge.Z;
MinEdge.Z = MaxEdge.Z;
MaxEdge.Z = t;
}
}
// Check if MaxEdge > MinEdge
bool isValid() const
{
if (MinEdge.X > MaxEdge.X) return false;
if (MinEdge.Y > MaxEdge.Y) return false;
if (MinEdge.Z > MaxEdge.Z) return false;
if (MinEdge.X > MaxEdge.X)
return false;
if (MinEdge.Y > MaxEdge.Y)
return false;
if (MinEdge.Z > MaxEdge.Z)
return false;
return true;
}
@ -207,18 +231,18 @@ class aabbox3d
\param other Other box to interpolate between
\param d Value between 0.0f and 1.0f.
\return Interpolated box. */
aabbox3d<T> getInterpolated(const aabbox3d<T>& other, f32 d) const
aabbox3d<T> getInterpolated(const aabbox3d<T> &other, f32 d) const
{
f32 inv = 1.0f - d;
return aabbox3d<T>((other.MinEdge*inv) + (MinEdge*d),
(other.MaxEdge*inv) + (MaxEdge*d));
return aabbox3d<T>((other.MinEdge * inv) + (MinEdge * d),
(other.MaxEdge * inv) + (MaxEdge * d));
}
//! Determines if a point is within this box.
/** Border is included (IS part of the box)!
\param p: Point to check.
\return True if the point is within the box and false if not */
bool isPointInside(const vector3d<T>& p) const
bool isPointInside(const vector3d<T> &p) const
{
return (p.X >= MinEdge.X && p.X <= MaxEdge.X &&
p.Y >= MinEdge.Y && p.Y <= MaxEdge.Y &&
@ -229,7 +253,7 @@ class aabbox3d
/** Border is excluded (NOT part of the box)!
\param p: Point to check.
\return True if the point is within the box and false if not. */
bool isPointTotalInside(const vector3d<T>& p) const
bool isPointTotalInside(const vector3d<T> &p) const
{
return (p.X > MinEdge.X && p.X < MaxEdge.X &&
p.Y > MinEdge.Y && p.Y < MaxEdge.Y &&
@ -240,14 +264,14 @@ class aabbox3d
/** \param other: Other box to check against.
\return True if this box is completely inside the other box,
otherwise false. */
bool isFullInside(const aabbox3d<T>& other) const
bool isFullInside(const aabbox3d<T> &other) const
{
return (MinEdge.X >= other.MinEdge.X && MinEdge.Y >= other.MinEdge.Y && MinEdge.Z >= other.MinEdge.Z &&
MaxEdge.X <= other.MaxEdge.X && MaxEdge.Y <= other.MaxEdge.Y && MaxEdge.Z <= other.MaxEdge.Z);
}
//! Returns the intersection of this box with another, if possible.
aabbox3d<T> intersect(const aabbox3d<T>& other) const
aabbox3d<T> intersect(const aabbox3d<T> &other) const
{
aabbox3d<T> out;
@ -269,7 +293,7 @@ class aabbox3d
/** \param other: Other box to check a intersection with.
\return True if there is an intersection with the other box,
otherwise false. */
bool intersectsWithBox(const aabbox3d<T>& other) const
bool intersectsWithBox(const aabbox3d<T> &other) const
{
return (MinEdge.X <= other.MaxEdge.X && MinEdge.Y <= other.MaxEdge.Y && MinEdge.Z <= other.MaxEdge.Z &&
MaxEdge.X >= other.MinEdge.X && MaxEdge.Y >= other.MinEdge.Y && MaxEdge.Z >= other.MinEdge.Z);
@ -278,7 +302,7 @@ class aabbox3d
//! Tests if the box intersects with a line
/** \param line: Line to test intersection with.
\return True if there is an intersection , else false. */
bool intersectsWithLine(const line3d<T>& line) const
bool intersectsWithLine(const line3d<T> &line) const
{
return intersectsWithLine(line.getMiddle(), line.getVector().normalize(),
(T)(line.getLength() * 0.5));
@ -289,27 +313,27 @@ class aabbox3d
\param linevect Vector of the line.
\param halflength Half length of the line.
\return True if there is an intersection, else false. */
bool intersectsWithLine(const vector3d<T>& linemiddle,
const vector3d<T>& linevect, T halflength) const
bool intersectsWithLine(const vector3d<T> &linemiddle,
const vector3d<T> &linevect, T halflength) const
{
const vector3d<T> e = getExtent() * (T)0.5;
const vector3d<T> t = getCenter() - linemiddle;
if ((fabs(t.X) > e.X + halflength * fabs(linevect.X)) ||
(fabs(t.Y) > e.Y + halflength * fabs(linevect.Y)) ||
(fabs(t.Z) > e.Z + halflength * fabs(linevect.Z)) )
(fabs(t.Z) > e.Z + halflength * fabs(linevect.Z)))
return false;
T r = e.Y * (T)fabs(linevect.Z) + e.Z * (T)fabs(linevect.Y);
if (fabs(t.Y*linevect.Z - t.Z*linevect.Y) > r )
if (fabs(t.Y * linevect.Z - t.Z * linevect.Y) > r)
return false;
r = e.X * (T)fabs(linevect.Z) + e.Z * (T)fabs(linevect.X);
if (fabs(t.Z*linevect.X - t.X*linevect.Z) > r )
if (fabs(t.Z * linevect.X - t.X * linevect.Z) > r)
return false;
r = e.X * (T)fabs(linevect.Y) + e.Y * (T)fabs(linevect.X);
if (fabs(t.X*linevect.Y - t.Y*linevect.X) > r)
if (fabs(t.X * linevect.Y - t.Y * linevect.X) > r)
return false;
return true;
@ -320,25 +344,22 @@ class aabbox3d
\return Returns ISREL3D_FRONT if the box is in front of the plane,
ISREL3D_BACK if the box is behind the plane, and
ISREL3D_CLIPPED if it is on both sides of the plane. */
EIntersectionRelation3D classifyPlaneRelation(const plane3d<T>& plane) const
EIntersectionRelation3D classifyPlaneRelation(const plane3d<T> &plane) const
{
vector3d<T> nearPoint(MaxEdge);
vector3d<T> farPoint(MinEdge);
if (plane.Normal.X > (T)0)
{
if (plane.Normal.X > (T)0) {
nearPoint.X = MinEdge.X;
farPoint.X = MaxEdge.X;
}
if (plane.Normal.Y > (T)0)
{
if (plane.Normal.Y > (T)0) {
nearPoint.Y = MinEdge.Y;
farPoint.Y = MaxEdge.Y;
}
if (plane.Normal.Z > (T)0)
{
if (plane.Normal.Z > (T)0) {
nearPoint.Z = MinEdge.Z;
farPoint.Z = MaxEdge.Z;
}
@ -359,10 +380,10 @@ class aabbox3d
vector3d<T> MaxEdge;
};
//! Typedef for a f32 3d bounding box.
typedef aabbox3d<f32> aabbox3df;
//! Typedef for an integer 3d bounding box.
typedef aabbox3d<s32> aabbox3di;
//! Typedef for a f32 3d bounding box.
typedef aabbox3d<f32> aabbox3df;
//! Typedef for an integer 3d bounding box.
typedef aabbox3d<s32> aabbox3di;
} // end namespace core
} // end namespace irr

141
include/coreutil.h
View File

@ -19,62 +19,61 @@ namespace core
// ----------- some basic quite often used string functions -----------------
//! search if a filename has a proper extension
inline s32 isFileExtension (const io::path& filename, const io::path& ext0,
const io::path& ext1, const io::path& ext2)
inline s32 isFileExtension(const io::path &filename, const io::path &ext0,
const io::path &ext1, const io::path &ext2)
{
s32 extPos = filename.findLast ( '.' );
if ( extPos < 0 )
s32 extPos = filename.findLast('.');
if (extPos < 0)
return 0;
extPos += 1;
if ( filename.equals_substring_ignore_case ( ext0, extPos ) )
if (filename.equals_substring_ignore_case(ext0, extPos))
return 1;
if ( filename.equals_substring_ignore_case ( ext1, extPos ) )
if (filename.equals_substring_ignore_case(ext1, extPos))
return 2;
if ( filename.equals_substring_ignore_case ( ext2, extPos ) )
if (filename.equals_substring_ignore_case(ext2, extPos))
return 3;
return 0;
}
//! search if a filename has a proper extension
inline bool hasFileExtension(const io::path& filename, const io::path& ext0,
const io::path& ext1 = "", const io::path& ext2 = "")
inline bool hasFileExtension(const io::path &filename, const io::path &ext0,
const io::path &ext1 = "", const io::path &ext2 = "")
{
return isFileExtension ( filename, ext0, ext1, ext2 ) > 0;
return isFileExtension(filename, ext0, ext1, ext2) > 0;
}
//! cut the filename extension from a source file path and store it in a dest file path
inline io::path& cutFilenameExtension ( io::path &dest, const io::path &source )
inline io::path &cutFilenameExtension(io::path &dest, const io::path &source)
{
s32 endPos = source.findLast ( '.' );
dest = source.subString ( 0, endPos < 0 ? source.size () : endPos );
s32 endPos = source.findLast('.');
dest = source.subString(0, endPos < 0 ? source.size() : endPos);
return dest;
}
//! get the filename extension from a file path
inline io::path& getFileNameExtension ( io::path &dest, const io::path &source )
inline io::path &getFileNameExtension(io::path &dest, const io::path &source)
{
s32 endPos = source.findLast ( '.' );
if ( endPos < 0 )
s32 endPos = source.findLast('.');
if (endPos < 0)
dest = "";
else
dest = source.subString ( endPos, source.size () );
dest = source.subString(endPos, source.size());
return dest;
}
//! delete path from filename
inline io::path& deletePathFromFilename(io::path& filename)
inline io::path &deletePathFromFilename(io::path &filename)
{
// delete path from filename
const fschar_t* s = filename.c_str();
const fschar_t* p = s + filename.size();
const fschar_t *s = filename.c_str();
const fschar_t *p = s + filename.size();
// search for path separator or beginning
while ( *p != '/' && *p != '\\' && p != s )
while (*p != '/' && *p != '\\' && p != s)
p--;
if ( p != s )
{
if (p != s) {
++p;
filename = p;
}
@ -82,51 +81,45 @@ inline io::path& deletePathFromFilename(io::path& filename)
}
//! trim paths
inline io::path& deletePathFromPath(io::path& filename, s32 pathCount)
inline io::path &deletePathFromPath(io::path &filename, s32 pathCount)
{
// delete path from filename
s32 i = filename.size();
// search for path separator or beginning
while ( i>=0 )
{
if ( filename[i] == '/' || filename[i] == '\\' )
{
if ( --pathCount <= 0 )
while (i >= 0) {
if (filename[i] == '/' || filename[i] == '\\') {
if (--pathCount <= 0)
break;
}
--i;
}
if ( i>0 )
{
filename [ i + 1 ] = 0;
if (i > 0) {
filename[i + 1] = 0;
filename.validate();
}
else
filename="";
} else
filename = "";
return filename;
}
//! looks if file is in the same directory of path. returns offset of directory.
//! 0 means in same directory. 1 means file is direct child of path
inline s32 isInSameDirectory ( const io::path& path, const io::path& file )
inline s32 isInSameDirectory(const io::path &path, const io::path &file)
{
if ( path.size() && !path.equalsn ( file, path.size() ) )
if (path.size() && !path.equalsn(file, path.size()))
return -1;
s32 subA = 0;
s32 subB = 0;
s32 pos = 0;
while ( (pos = path.findNext ( '/', pos )) >= 0 )
{
while ((pos = path.findNext('/', pos)) >= 0) {
subA += 1;
pos += 1;
}
pos = 0;
while ( (pos = file.findNext ( '/', pos )) >= 0 )
{
while ((pos = file.findNext('/', pos)) >= 0) {
subB += 1;
pos += 1;
}
@ -135,55 +128,47 @@ inline s32 isInSameDirectory ( const io::path& path, const io::path& file )
}
//! splits a path into components
static inline void splitFilename(const io::path &name, io::path* path=0,
io::path* filename=0, io::path* extension=0, bool make_lower=false)
static inline void splitFilename(const io::path &name, io::path *path = 0,
io::path *filename = 0, io::path *extension = 0, bool make_lower = false)
{
s32 i = name.size();
s32 extpos = i;
// search for path separator or beginning
while ( i >= 0 )
{
if ( name[i] == '.' )
{
while (i >= 0) {
if (name[i] == '.') {
extpos = i;
if ( extension )
*extension = name.subString ( extpos + 1, name.size() - (extpos + 1), make_lower );
}
else
if ( name[i] == '/' || name[i] == '\\' )
{
if ( filename )
*filename = name.subString ( i + 1, extpos - (i + 1), make_lower );
if ( path )
{
*path = name.subString ( 0, i + 1, make_lower );
path->replace ( '\\', '/' );
if (extension)
*extension = name.subString(extpos + 1, name.size() - (extpos + 1), make_lower);
} else if (name[i] == '/' || name[i] == '\\') {
if (filename)
*filename = name.subString(i + 1, extpos - (i + 1), make_lower);
if (path) {
*path = name.subString(0, i + 1, make_lower);
path->replace('\\', '/');
}
return;
}
i -= 1;
}
if ( filename )
*filename = name.subString ( 0, extpos, make_lower );
if (filename)
*filename = name.subString(0, extpos, make_lower);
}
//! create a filename from components
static inline io::path mergeFilename(const io::path& path, const io::path& filename, const io::path& extension = "")
static inline io::path mergeFilename(const io::path &path, const io::path &filename, const io::path &extension = "")
{
io::path result(path);
if ( !result.empty() )
{
if (!result.empty()) {
fschar_t last = result.lastChar();
if ( last != _IRR_TEXT('/') && last != _IRR_TEXT('\\') )
if (last != _IRR_TEXT('/') && last != _IRR_TEXT('\\'))
result += _IRR_TEXT('/');
}
if ( !filename.empty() )
if (!filename.empty())
result += filename;
if ( !extension.empty() )
{
if ( !result.empty() && extension[0] != _IRR_TEXT('.') )
if (!extension.empty()) {
if (!result.empty() && extension[0] != _IRR_TEXT('.'))
result += _IRR_TEXT('.');
result += extension;
}
@ -191,13 +176,19 @@ static inline io::path mergeFilename(const io::path& path, const io::path& filen
return result;
}
//! some standard function ( to remove dependencies )
inline bool isdigit(s32 c) { return c >= '0' && c <= '9'; }
inline bool isspace(s32 c) { return c == ' ' || c == '\f' || c == '\n' || c == '\r' || c == '\t' || c == '\v'; }
inline bool isupper(s32 c) { return c >= 'A' && c <= 'Z'; }
inline bool isdigit(s32 c)
{
return c >= '0' && c <= '9';
}
inline bool isspace(s32 c)
{
return c == ' ' || c == '\f' || c == '\n' || c == '\r' || c == '\t' || c == '\v';
}
inline bool isupper(s32 c)
{
return c >= 'A' && c <= 'Z';
}
} // end namespace core
} // end namespace irr

150
include/dimension2d.h
View File

@ -11,58 +11,60 @@ namespace irr
{
namespace core
{
template <class T>
class vector2d;
template <class T>
class vector2d;
//! Specifies a 2 dimensional size.
template <class T>
class dimension2d
{
public:
//! Specifies a 2 dimensional size.
template <class T>
class dimension2d
{
public:
//! Default constructor for empty dimension
constexpr dimension2d() : Width(0), Height(0) {}
constexpr dimension2d() :
Width(0), Height(0) {}
//! Constructor with width and height
constexpr dimension2d(const T& width, const T& height)
: Width(width), Height(height) {}
constexpr dimension2d(const T &width, const T &height) :
Width(width), Height(height) {}
dimension2d(const vector2d<T>& other); // Defined in vector2d.h
dimension2d(const vector2d<T> &other); // Defined in vector2d.h
//! Use this constructor only where you are sure that the conversion is valid.
template <class U>
explicit constexpr dimension2d(const dimension2d<U>& other) :
Width((T)other.Width), Height((T)other.Height) { }
explicit constexpr dimension2d(const dimension2d<U> &other) :
Width((T)other.Width), Height((T)other.Height)
{
}
template <class U>
dimension2d<T>& operator=(const dimension2d<U>& other)
dimension2d<T> &operator=(const dimension2d<U> &other)
{
Width = (T) other.Width;
Height = (T) other.Height;
Width = (T)other.Width;
Height = (T)other.Height;
return *this;
}
//! Equality operator
bool operator==(const dimension2d<T>& other) const
bool operator==(const dimension2d<T> &other) const
{
return core::equals(Width, other.Width) &&
core::equals(Height, other.Height);
}
//! Inequality operator
bool operator!=(const dimension2d<T>& other) const
bool operator!=(const dimension2d<T> &other) const
{
return ! (*this == other);
return !(*this == other);
}
bool operator==(const vector2d<T>& other) const; // Defined in vector2d.h
bool operator==(const vector2d<T> &other) const; // Defined in vector2d.h
bool operator!=(const vector2d<T>& other) const
bool operator!=(const vector2d<T> &other) const
{
return !(*this == other);
}
//! Set to new values
dimension2d<T>& set(const T& width, const T& height)
dimension2d<T> &set(const T &width, const T &height)
{
Width = width;
Height = height;
@ -70,7 +72,7 @@ namespace core
}
//! Divide width and height by scalar
dimension2d<T>& operator/=(const T& scale)
dimension2d<T> &operator/=(const T &scale)
{
Width /= scale;
Height /= scale;
@ -78,13 +80,13 @@ namespace core
}
//! Divide width and height by scalar
dimension2d<T> operator/(const T& scale) const
dimension2d<T> operator/(const T &scale) const
{
return dimension2d<T>(Width/scale, Height/scale);
return dimension2d<T>(Width / scale, Height / scale);
}
//! Multiply width and height by scalar
dimension2d<T>& operator*=(const T& scale)
dimension2d<T> &operator*=(const T &scale)
{
Width *= scale;
Height *= scale;
@ -92,13 +94,13 @@ namespace core
}
//! Multiply width and height by scalar
dimension2d<T> operator*(const T& scale) const
dimension2d<T> operator*(const T &scale) const
{
return dimension2d<T>(Width*scale, Height*scale);
return dimension2d<T>(Width * scale, Height * scale);
}
//! Add another dimension to this one.
dimension2d<T>& operator+=(const dimension2d<T>& other)
dimension2d<T> &operator+=(const dimension2d<T> &other)
{
Width += other.Width;
Height += other.Height;
@ -106,13 +108,13 @@ namespace core
}
//! Add two dimensions
dimension2d<T> operator+(const dimension2d<T>& other) const
dimension2d<T> operator+(const dimension2d<T> &other) const
{
return dimension2d<T>(Width+other.Width, Height+other.Height);
return dimension2d<T>(Width + other.Width, Height + other.Height);
}
//! Subtract a dimension from this one
dimension2d<T>& operator-=(const dimension2d<T>& other)
dimension2d<T> &operator-=(const dimension2d<T> &other)
{
Width -= other.Width;
Height -= other.Height;
@ -120,15 +122,15 @@ namespace core
}
//! Subtract one dimension from another
dimension2d<T> operator-(const dimension2d<T>& other) const
dimension2d<T> operator-(const dimension2d<T> &other) const
{
return dimension2d<T>(Width-other.Width, Height-other.Height);
return dimension2d<T>(Width - other.Width, Height - other.Height);
}
//! Get area
T getArea() const
{
return Width*Height;
return Width * Height;
}
//! Get the optimal size according to some properties
@ -147,76 +149,68 @@ namespace core
\return The optimal dimension under the given
constraints. */
dimension2d<T> getOptimalSize(
bool requirePowerOfTwo=true,
bool requireSquare=false,
bool larger=true,
bool requirePowerOfTwo = true,
bool requireSquare = false,
bool larger = true,
u32 maxValue = 0) const
{
u32 i=1;
u32 j=1;
if (requirePowerOfTwo)
{
while (i<(u32)Width)
i<<=1;
if (!larger && i!=1 && i!=(u32)Width)
i>>=1;
while (j<(u32)Height)
j<<=1;
if (!larger && j!=1 && j!=(u32)Height)
j>>=1;
}
else
{
i=(u32)Width;
j=(u32)Height;
u32 i = 1;
u32 j = 1;
if (requirePowerOfTwo) {
while (i < (u32)Width)
i <<= 1;
if (!larger && i != 1 && i != (u32)Width)
i >>= 1;
while (j < (u32)Height)
j <<= 1;
if (!larger && j != 1 && j != (u32)Height)
j >>= 1;
} else {
i = (u32)Width;
j = (u32)Height;
}
if (requireSquare)
{
if ((larger && (i>j)) || (!larger && (i<j)))
j=i;
if (requireSquare) {
if ((larger && (i > j)) || (!larger && (i < j)))
j = i;
else
i=j;
i = j;
}
if ( maxValue > 0 && i > maxValue)
if (maxValue > 0 && i > maxValue)
i = maxValue;
if ( maxValue > 0 && j > maxValue)
if (maxValue > 0 && j > maxValue)
j = maxValue;
return dimension2d<T>((T)i,(T)j);
return dimension2d<T>((T)i, (T)j);
}
//! Get the interpolated dimension
/** \param other Other dimension to interpolate with.
\param d Value between 0.0f and 1.0f. d=0 returns other, d=1 returns this, values between interpolate.
\return Interpolated dimension. */
dimension2d<T> getInterpolated(const dimension2d<T>& other, f32 d) const
dimension2d<T> getInterpolated(const dimension2d<T> &other, f32 d) const
{
f32 inv = (1.0f - d);
return dimension2d<T>( (T)(other.Width*inv + Width*d), (T)(other.Height*inv + Height*d));
return dimension2d<T>((T)(other.Width * inv + Width * d), (T)(other.Height * inv + Height * d));
}
//! Width of the dimension.
T Width;
//! Height of the dimension.
T Height;
};
};
//! Typedef for an f32 dimension.
typedef dimension2d<f32> dimension2df;
//! Typedef for an unsigned integer dimension.
typedef dimension2d<u32> dimension2du;
//! Typedef for an f32 dimension.
typedef dimension2d<f32> dimension2df;
//! Typedef for an unsigned integer dimension.
typedef dimension2d<u32> dimension2du;
//! Typedef for an integer dimension.
/** There are few cases where negative dimensions make sense. Please consider using
//! Typedef for an integer dimension.
/** There are few cases where negative dimensions make sense. Please consider using
dimension2du instead. */
typedef dimension2d<s32> dimension2di;
typedef dimension2d<s32> dimension2di;
} // end namespace core
} // end namespace irr

117
include/fast_atof.h
View File

@ -31,8 +31,7 @@ const float fast_atof_table[17] = {
0.0000000000001f,
0.00000000000001f,
0.000000000000001f,
0.0000000000000001f
};
0.0000000000000001f};
//! Convert a simple string of base 10 digits into an unsigned 32 bit integer.
/** \param[in] in: The string of digits to convert. No leading chars are
@ -42,24 +41,21 @@ const float fast_atof_table[17] = {
\return The unsigned integer value of the digits. If the string specifies
too many digits to encode in an u32 then INT_MAX will be returned.
*/
inline u32 strtoul10(const char* in, const char** out=0)
inline u32 strtoul10(const char *in, const char **out = 0)
{
if (!in)
{
if (!in) {
if (out)
*out = in;
return 0;
}
bool overflow=false;
bool overflow = false;
u32 unsignedValue = 0;
while ( ( *in >= '0') && ( *in <= '9' ))
{
const u32 tmp = ( unsignedValue * 10 ) + ( *in - '0' );
if (tmp<unsignedValue)
{
unsignedValue=(u32)0xffffffff;
overflow=true;
while ((*in >= '0') && (*in <= '9')) {
const u32 tmp = (unsignedValue * 10) + (*in - '0');
if (tmp < unsignedValue) {
unsignedValue = (u32)0xffffffff;
overflow = true;
}
if (!overflow)
unsignedValue = tmp;
@ -82,10 +78,9 @@ inline u32 strtoul10(const char* in, const char** out=0)
too many digits to encode in an s32 then +INT_MAX or -INT_MAX will be
returned.
*/
inline s32 strtol10(const char* in, const char** out=0)
inline s32 strtol10(const char *in, const char **out = 0)
{
if (!in)
{
if (!in) {
if (out)
*out = in;
return 0;
@ -95,16 +90,13 @@ inline s32 strtol10(const char* in, const char** out=0)
if (negative || ('+' == *in))
++in;
const u32 unsignedValue = strtoul10(in,out);
if (unsignedValue > (u32)INT_MAX)
{
const u32 unsignedValue = strtoul10(in, out);
if (unsignedValue > (u32)INT_MAX) {
if (negative)
return (s32)INT_MIN;
else
return (s32)INT_MAX;
}
else
{
} else {
if (negative)
return -((s32)unsignedValue);
else
@ -139,19 +131,17 @@ inline u32 ctoul16(char in)
\return The unsigned integer value of the digits. If the string specifies
too many digits to encode in an u32 then INT_MAX will be returned.
*/
inline u32 strtoul16(const char* in, const char** out=0)
inline u32 strtoul16(const char *in, const char **out = 0)
{
if (!in)
{
if (!in) {
if (out)
*out = in;
return 0;
}
bool overflow=false;
bool overflow = false;
u32 unsignedValue = 0;
while (true)
{
while (true) {
u32 tmp = 0;
if ((*in >= '0') && (*in <= '9'))
tmp = (unsignedValue << 4u) + (*in - '0');
@ -161,10 +151,9 @@ inline u32 strtoul16(const char* in, const char** out=0)
tmp = (unsignedValue << 4u) + (*in - 'a') + 10;
else
break;
if (tmp<unsignedValue)
{
unsignedValue=(u32)INT_MAX;
overflow=true;
if (tmp < unsignedValue) {
unsignedValue = (u32)INT_MAX;
overflow = true;
}
if (!overflow)
unsignedValue = tmp;
@ -186,28 +175,25 @@ inline u32 strtoul16(const char* in, const char** out=0)
\return The unsigned integer value of the digits. If the string specifies
too many digits to encode in an u32 then INT_MAX will be returned.
*/
inline u32 strtoul8(const char* in, const char** out=0)
inline u32 strtoul8(const char *in, const char **out = 0)
{
if (!in)
{
if (!in) {
if (out)
*out = in;
return 0;
}
bool overflow=false;
bool overflow = false;
u32 unsignedValue = 0;
while (true)
{
while (true) {
u32 tmp = 0;
if ((*in >= '0') && (*in <= '7'))
tmp = (unsignedValue << 3u) + (*in - '0');
else
break;
if (tmp<unsignedValue)
{
unsignedValue=(u32)INT_MAX;
overflow=true;
if (tmp < unsignedValue) {
unsignedValue = (u32)INT_MAX;
overflow = true;
}
if (!overflow)
unsignedValue = tmp;
@ -229,17 +215,16 @@ inline u32 strtoul8(const char* in, const char** out=0)
\return The unsigned integer value of the digits. If the string specifies
too many digits to encode in an u32 then INT_MAX will be returned.
*/
inline u32 strtoul_prefix(const char* in, const char** out=0)
inline u32 strtoul_prefix(const char *in, const char **out = 0)
{
if (!in)
{
if (!in) {
if (out)
*out = in;
return 0;
}
if ('0'==in[0])
return ('x'==in[1] ? strtoul16(in+2,out) : strtoul8(in+1,out));
return strtoul10(in,out);
if ('0' == in[0])
return ('x' == in[1] ? strtoul16(in + 2, out) : strtoul8(in + 1, out));
return strtoul10(in, out);
}
//! Converts a sequence of digits into a whole positive floating point value.
@ -251,10 +236,9 @@ inline u32 strtoul_prefix(const char* in, const char** out=0)
\return The whole positive floating point representation of the digit
sequence.
*/
inline f32 strtof10(const char* in, const char** out = 0)
inline f32 strtof10(const char *in, const char **out = 0)
{
if (!in)
{
if (!in) {
if (out)
*out = in;
return 0.f;
@ -265,8 +249,7 @@ inline f32 strtof10(const char* in, const char** out = 0)
// Use integer arithmetic for as long as possible, for speed
// and precision.
while ( ( *in >= '0') && ( *in <= '9' ) )
{
while ((*in >= '0') && (*in <= '9')) {
// If it looks like we're going to overflow, bail out
// now and start using floating point.
if (intValue >= MAX_SAFE_U32_VALUE)
@ -280,8 +263,7 @@ inline f32 strtof10(const char* in, const char** out = 0)
// If there are any digits left to parse, then we need to use
// floating point arithmetic from here.
while ( ( *in >= '0') && ( *in <= '9' ) )
{
while ((*in >= '0') && (*in <= '9')) {
floatValue = (floatValue * 10.f) + (f32)(*in - '0');
++in;
if (floatValue > FLT_MAX) // Just give up.
@ -302,7 +284,7 @@ inline f32 strtof10(const char* in, const char** out = 0)
\return Pointer to the first character in the string that wasn't used
to create the float value.
*/
inline const char* fast_atof_move(const char* in, f32& result)
inline const char *fast_atof_move(const char *in, f32 &result)
{
// Please run the regression test when making any modifications to this function.
@ -311,29 +293,24 @@ inline const char* fast_atof_move(const char* in, f32& result)
return 0;
const bool negative = ('-' == *in);
if (negative || ('+'==*in))
if (negative || ('+' == *in))
++in;
f32 value = strtof10(in, &in);
if ( *in == '.' )
{
const char* afterDecimal = ++in;
if (*in == '.') {
const char *afterDecimal = ++in;
const f32 decimal = strtof10(in, &afterDecimal);
const size_t numDecimals = afterDecimal - in;
if (numDecimals < IRR_ATOF_TABLE_SIZE)
{
if (numDecimals < IRR_ATOF_TABLE_SIZE) {
value += decimal * fast_atof_table[numDecimals];
}
else
{
} else {
value += decimal * (f32)pow(10.f, -(float)numDecimals);
}
in = afterDecimal;
}
if ('e' == *in || 'E' == *in)
{
if ('e' == *in || 'E' == *in) {
++in;
// Assume that the exponent is a whole number.
// strtol10() will deal with both + and - signs,
@ -342,7 +319,7 @@ inline const char* fast_atof_move(const char* in, f32& result)
value *= (f32)pow(10.f, (f32)strtol10(in, &in));
}
result = negative?-value:value;
result = negative ? -value : value;
return in;
}
@ -352,11 +329,11 @@ inline const char* fast_atof_move(const char* in, f32& result)
wasn't used to create the float value.
\result Float value parsed from the input string
*/
inline float fast_atof(const char* floatAsString, const char** out=0)
inline float fast_atof(const char *floatAsString, const char **out = 0)
{
float ret;
if (out)
*out=fast_atof_move(floatAsString, ret);
*out = fast_atof_move(floatAsString, ret);
else
fast_atof_move(floatAsString, ret);
return ret;

Some files were not shown because too many files have changed in this diff Show More