Documentation/Entity Types/Base/Map.type

From NeoAxis 3D Engine Wiki

Jump to: navigation, search
Go to higher level

Description

Map.type object type is located in Objects Map Editor window with the other map objects.. While creating a new map the object is created automatically and in a single copy, and it is put at the head of the map object hierarchy.

Map 01.jpg

Configuration

Map 02.jpg

You can configure Map.type object in the same way as the ordinary object using the properties window. At first you should choose it in the objects window. Special map configurations are devided into two groups: GameMap and Map.

Name Description
class Entity
Components List of attached components.
LogicClass Reference to the Logic Editor class. Read more about how to work with the Logic Editor class.
Name Object name.
Tags User defined information. Defined as keyvalue pairs. It is used for user's needs.
Type Object type. It can not be changed.
class GameMap
DestroyObjectsBellowHeight Minimum limit height which the object can get before it will be destroyed.
GameMusic Music file, which will be played after the loading.
GameType Map type. It is possible to choose among the accessible variants, the rang of which you can find in SDK, such as: None, Action, RTS, TPSArcade, TurrentDemo, VillageDemo and some others. Each type differs its proper logic and control peculiarities. Creators can add their own types while creating the object. You can read more about adding a new map object here.
PlayerUnitType Game personage type. If the type is not chosen, Girl.type (a girl) should be used.
ResetYCoordinateForDynamicBodies Enables/Disables the mode, in which the Y-coordinate will be vanished for each dynamic physical bodies. It allows to realize the simylation of two dimensional physics on the map.
WindDirection Wind direction. At this moment the parameter can be used only for Vegetation material.
WindSpeed Wind speed. At this moment the parameter can be used only for Vegetation material.
class Map
AmbientLight Map background lighting color. This parameter allows to make something lighner or darker, ex. unlighted corridor.
CameraOrthoWindowHeight The height of orthographic camera (Orthographic). Look the property CameraProjectionType.
CameraProjectionType Camera projection type. You can choose among two values: Perspective and Orthographic. Perspective is the standart camera state. The objects appearance is changed relative to the angle of vision. This type of camera creates the perspective of the image in three-dimensional scene. Orthographic is the type of camera without perspective. It creates orthographic scene projection. It can be used for creating the direct projections (ex. imitating the view in front or the top view) and axonometric projections. With the help of CameraOrthoWindowHeight parameter you can configurate the orthographic camera height.
Fov Focus of Vision. With this parameter you can set the angle of vision.
NearFarClipDistance Near and far distance for camera vision clipping. The first value, besides the clipping of nearby objects, influences on the allocation of values in depth buffer. To make it more productive you should use the minimal possible meaningof distant vision. To allocate it in the depth buffer better, you should use the maximal possible meaning of near vision.
SceneGraphSettings Scene Graph settings. The detailed description of it is given below.
ShadowColor Shadow color. Only contrast can be created for shadows based on textures.
ShadowDirectionalLightMaxTextureCount Maximal number of textures for Directional light sources shadows generation. If the number of light sources which require shadows is more than the set value, the shadows for more remote light sources will not be painted.
ShadowDirectionalLightTextureSize Texture size for Directional light sources shadows.
ShadowFarDistance Maxsimal distance, with which the shadows from objects are visible.
ShadowPointLightMaxTextureCount Maximal texture count for Poing light sources shadows generation. If the number of light sources which require shadows is more than the set value, the shadows for more remote light sources will not be painted.
ShadowPointLightTextureSize Texture size for Point light sources shadows.
ShadowPSSMSplitFactors Texture allocation interval depending on the distance for Parallel-Split Shadow Map shadows.
ShadowSpotLightMaxTextureCount Максимальное количество текстур для генерации теней от прожекторов (Spot-источников света).Maximal texture count for Spots shadows generation. If the number of light sources which require shadows is more than the set value, the shadows for more remote light sources will not be painted.
ShadowSpotLightTextureSize Texture size for Spots shadows.
ShadowTechnique Shadows painting technique. If it is set to None, the shadows will not be painted.
SoundDopplerEffectFactor Doppler effect coefficient while sounds playback.
StaticBatchingFilterByMaxTriangleCount Maximal count of triangles in 3D-mesh for turning on the batch operation.
StaticBatchingGridCellSize The size of cells for batch operation cut.
StaticBatchingPhysicsEnabledInMapEditor Enables/Disables the batch operation for optimization of Map Editor physical calculations. The batch operation can be used only for static objects.
StaticBatchingPhysicsEnabledInSimulation Enables/Disables the static objects batch operation for optimization of Map Editor physical calculations. The batch operation can be used only for static objects.
StaticBatchingRenderingEnabled Enables/Disables static objects batch operation for optimization of rendering (joining up a quantity of 3D meshes into a one for rendering and physics calculation speed increase).

Scene Graph properties

Scene Graph properties are available in SceneGraphSettings parameter properties.

Name Description
AmountOfObjectsOutsideOctreeBoundsToRebuild Maximal number of objects out of graph dimension, which is necessary to recount the graph.
MaxNodeCount Maximal number of nodes in scene graph.
MinNodeSize Minimal number of objects in the graph node.
ObjectCountThresholdToCreateChildNodes Maximal number of objects in the graph node for creating a new hierarchy level.
OctreeBoundsRebuildExpand Values for adding to the available graph size while graph dimension recounting.