scene.h File Reference

Defines the data structures in which the imported scene is returned. More...

Classes
struct	aiNode
	A node in the imported hierarchy. More...
struct	aiScene
	The root structure of the imported data. More...

Macros
#define	AI_SCENE_FLAGS_ALLOW_SHARED   0x20
	Specifies that the scene data can be shared between structures. More...
#define	AI_SCENE_FLAGS_INCOMPLETE   0x1
	Specifies that the scene data structure that was imported is not complete. More...
#define	AI_SCENE_FLAGS_NON_VERBOSE_FORMAT   0x8
	This flag is currently only set by the aiProcess_JoinIdenticalVertices step. More...
#define	AI_SCENE_FLAGS_TERRAIN   0x10
	Denotes pure height-map terrain data. More...
#define	AI_SCENE_FLAGS_VALIDATED   0x2
	This flag is set by the validation postprocess-step (aiPostProcess_ValidateDS) if the validation is successful. More...
#define	AI_SCENE_FLAGS_VALIDATION_WARNING   0x4
	This flag is set by the validation postprocess-step (aiPostProcess_ValidateDS) if the validation is successful but some issues have been found. More...
#define	AI_SCENE_H_INC

Detailed Description

Defines the data structures in which the imported scene is returned.

Macro Definition Documentation

AI_SCENE_FLAGS_ALLOW_SHARED

#define AI_SCENE_FLAGS_ALLOW_SHARED   0x20

Specifies that the scene data can be shared between structures.

For example: one vertex in few faces. AI_SCENE_FLAGS_NON_VERBOSE_FORMAT can not be used for this because AI_SCENE_FLAGS_NON_VERBOSE_FORMAT has internal meaning about postprocessing steps.

AI_SCENE_FLAGS_INCOMPLETE

#define AI_SCENE_FLAGS_INCOMPLETE   0x1

Specifies that the scene data structure that was imported is not complete.

This flag bypasses some internal validations and allows the import of animation skeletons, material libraries or camera animation paths using Assimp. Most applications won't support such data.

AI_SCENE_FLAGS_NON_VERBOSE_FORMAT

#define AI_SCENE_FLAGS_NON_VERBOSE_FORMAT   0x8

This flag is currently only set by the aiProcess_JoinIdenticalVertices step.

It indicates that the vertices of the output meshes aren't in the internal verbose format anymore. In the verbose format all vertices are unique, no vertex is ever referenced by more than one face.

AI_SCENE_FLAGS_TERRAIN

#define AI_SCENE_FLAGS_TERRAIN   0x10

Denotes pure height-map terrain data.

Pure terrains usually consist of quads, sometimes triangles, in a regular grid. The x,y coordinates of all vertex positions refer to the x,y coordinates on the terrain height map, the z-axis stores the elevation at a specific point.

TER (Terragen) and HMP (3D Game Studio) are height map formats.

Note

Assimp is probably not the best choice for loading huge terrains - fully triangulated data takes extremely much free store and should be avoided as long as possible (typically you'll do the triangulation when you actually need to render it).

AI_SCENE_FLAGS_VALIDATED

#define AI_SCENE_FLAGS_VALIDATED   0x2

This flag is set by the validation postprocess-step (aiPostProcess_ValidateDS) if the validation is successful.

In a validated scene you can be sure that any cross references in the data structure (e.g. vertex indices) are valid.

AI_SCENE_FLAGS_VALIDATION_WARNING

#define AI_SCENE_FLAGS_VALIDATION_WARNING   0x4

This flag is set by the validation postprocess-step (aiPostProcess_ValidateDS) if the validation is successful but some issues have been found.

This can for example mean that a texture that does not exist is referenced by a material or that the bone weights for a vertex don't sum to 1.0 ... . In most cases you should still be able to use the import. This flag could be useful for applications which don't capture Assimp's log output.

AI_SCENE_H_INC

#define AI_SCENE_H_INC