Documentation

From NeoAxis 3D Engine Wiki

(Difference between revisions)
Jump to: navigation, search
Line 61: Line 61:
 
In the [[Documentation/Articles/Overview of Map Editor|Map Editor]] each object have ti's own type. You will find here a list of the base object types available in the SDK. In addition to theses base types, you can [[Documentation/Tutorials/Creating_a_Simple_Object_Type|create your own type of objects]] and place them in the Map Editor.
 
In the [[Documentation/Articles/Overview of Map Editor|Map Editor]] each object have ti's own type. You will find here a list of the base object types available in the SDK. In addition to theses base types, you can [[Documentation/Tutorials/Creating_a_Simple_Object_Type|create your own type of objects]] and place them in the Map Editor.
  
 +
Base object on the map:
 +
[[Documentation/Entity_Types/Base/Map.type|Map]] — Map object. This type is automatically created with a new map and can't be deleted.
  
 
+
Basic types:
XXXXXXXXXXXXXXXXXXXXXXXXXXXX
+
[[Documentation/Entity_Types/Base/Map.type|Map.type]] — Map object. This type is automatically created with a new map.
+
 
+
 
+
 
* Basic \ [[Документация/Типы_объектов/Special/CollisionVolume.type|CollisionVolume.type]] — Невидимое ограничивающее препятствие.
 
* Basic \ [[Документация/Типы_объектов/Special/CollisionVolume.type|CollisionVolume.type]] — Невидимое ограничивающее препятствие.
 
* Basic \ [[Documentation/Entity_Types/Base/DecorativeObjectManager.type|DecorativeObjectManager.type]] — This type allows you to create a large amount of objects (like grass, trees, rocks)to quickly populate your map.
 
* Basic \ [[Documentation/Entity_Types/Base/DecorativeObjectManager.type|DecorativeObjectManager.type]] — This type allows you to create a large amount of objects (like grass, trees, rocks)to quickly populate your map.
 
* Basic \ [[Documentation/Entity_Types/Base/Fog.type|Fog.type]] — Fog.
 
* Basic \ [[Documentation/Entity_Types/Base/Fog.type|Fog.type]] — Fog.
 
* Basic \ [[Documentation/Entity_Types/Base/GeneralMapObject.type|GeneralMapObject.type]] — The object on the map without behaviour. This object can be used to configure by means components.
 
* Basic \ [[Documentation/Entity_Types/Base/GeneralMapObject.type|GeneralMapObject.type]] — The object on the map without behaviour. This object can be used to configure by means components.
* Basic \ [[Документация/Типы объектов/Base/MapCompositorManager.type|MapCompositorManager.type]] — Позволяет добавлять на карту пост-эффекты.
+
* Basic \ [[Documentation/Entity_Types/Base/MapCompositorManager.type|MapCompositorManager.type]] — This type is used for setting up posteffects on the map.
* Basic \ [[Документация/Типы_объектов/Base/ParticleSystemSource.type|ParticleSystemSource.type]] — Позволяет расставлять источники частиц на карте.
+
* Basic \ [[Documentation/Entity_Types/Base/ParticleSystemSource.type|ParticleSystemSource.type]] — This type is used as a source of particles on the map.
* Basic \ [[Документация/Типы_объектов/Base/Region.type|Region.type]] — Область на карте.
+
* Basic \ [[Documentation/Entity_Types/Base/Region.type|Region.type]] — An area you place on the map (can be used as triggers).
* Basic \ [[Документация/Типы_объектов/Base/SkyBox.type|SkyBox.type]] — Небо в виде статичной кубической карты.
+
* Basic \ [[Documentation/Entity_Types/Base/SkyBox.type|SkyBox.type]] — Sky, using a cubic texture.
* Basic \ [[Документация/Типы_объектов/Base/SkyDome.type|SkyDome.type]] — Небо в виде полусферы.
+
* Basic \ [[Documentation/Entity_Types/Base/SkyDome.type|SkyDome.type]] — Sky, using a hemisphere.
* Basic \ [[Документация/Типы_объектов/Base/SoundSource.type|SoundSource.type]] — Источник звука на карте.
+
* Basic \ [[Documentation/Entity_Types/Base/SoundSource.type|SoundSource.type]] — Sound source on the map.
 
* Basic \ [[Документация/Типы_объектов/Special/SpawnPoint.type|SpawnPoint.type]] — Стартовая точка.
 
* Basic \ [[Документация/Типы_объектов/Special/SpawnPoint.type|SpawnPoint.type]] — Стартовая точка.
* Basic \ [[Документация/Типы_объектов/Base/StaticMesh.type|StaticMesh.type]] — Объект для создания статичной геометрии на карте.
+
* Basic \ [[Documentation/Entity_Types/Base/StaticMesh.type|StaticMesh.type]] — An object used for creating static geometry on the map.
* Camera \ [[Документация/Типы_объектов/Base/MapCamera.type|MapCamera.type]] — Позволяет расставлять камеры на карте.
+
* Camera \ [[Documentation/Entity_Types/Base/MapCamera.type|MapCamera.type]] — This type is used for setting cameras on the map.
* Camera \ [[Документация/Типы_объектов/Base/MapCameraCurve.type|MapCameraCurve.type]] — Позволяет задавать траекторию полета камеры.
+
* Camera \ [[Documentation/Entity_Types/Base/MapCameraCurve.type|MapCameraCurve.type]] — This type allows you to create a camera path.
 
* Lighting \ [[Documentation/Entity_Types/Base/CubemapZone.type|CubemapZone.type]] — Used to generate a cubemap texture of the environment.
 
* Lighting \ [[Documentation/Entity_Types/Base/CubemapZone.type|CubemapZone.type]] — Used to generate a cubemap texture of the environment.
 
* Lighting \ [[Documentation/Entity_Types/Base/CubemapZone_BoxParallaxCorrectedZone.type|CubemapZone_BoxParallaxCorrectedZone.type]] — Used to correct rendering reflections from cubemaps (CubemapZone.type).
 
* Lighting \ [[Documentation/Entity_Types/Base/CubemapZone_BoxParallaxCorrectedZone.type|CubemapZone_BoxParallaxCorrectedZone.type]] — Used to correct rendering reflections from cubemaps (CubemapZone.type).
 
* Lighting \ [[Documentation/Entity_Types/Base/LensFlareManager.type|LensFlareManager.type]] — The manager to manage lens flares from the Sun light source.
 
* Lighting \ [[Documentation/Entity_Types/Base/LensFlareManager.type|LensFlareManager.type]] — The manager to manage lens flares from the Sun light source.
 
* Lighting \ [[Documentation/Entity_Types/Base/Light.type|Light.type]] — Light source.
 
* Lighting \ [[Documentation/Entity_Types/Base/Light.type|Light.type]] — Light source.
* Lighting \ [[Документация/Типы_объектов/Base/StaticLightingManager.type|StaticLightingManager.type]] — Менеджер статичного освещения.
+
* Lighting \ [[Documentation/Entity_Types/Base/StaticLightingManager.type|StaticLightingManager.type]] — Allows you to configure precalculated static lighting.
* Lighting \ [[Документация/Типы_объектов/Base/Sun.type|Sun.type]] — Солнце.
+
* Lighting \ [[Documentation/Entity_Types/Base/Sun.type|Sun.type]] — Sun light source.
 
* Pathfinding \ [[Документация/Типы_объектов/Special/GridBasedNavigationSystem.type|GridBasedNavigationSystem.type]] — Система поиска пути на базе двумерной сетки.
 
* Pathfinding \ [[Документация/Типы_объектов/Special/GridBasedNavigationSystem.type|GridBasedNavigationSystem.type]] — Система поиска пути на базе двумерной сетки.
 
* Pathfinding \ [[Документация/Типы_объектов/Special/RecastNavigationSystem.type|RecastNavigationSystem.type]] — Система поиска пути на базе технологии Navigation Mesh.
 
* Pathfinding \ [[Документация/Типы_объектов/Special/RecastNavigationSystem.type|RecastNavigationSystem.type]] — Система поиска пути на базе технологии Navigation Mesh.
* Portal System \ [[Документация/Типы_объектов/Base/Occluder.type|Occluder.type]] — Служит для выключения порталов. Часть портальной системы.
+
* Portal System \ [[Documentation/Entity_Types/Base/Occluder.type|Occluder.type]] — Used for switching portals on and off. It's a part of the Portal System.
* Portal System \ [[Документация/Типы_объектов/Base/Portal.type|Portal.type]] — Портал. Часть портальной системы.
+
* Portal System \ [[Documentation/Entity_Types/Base/Portal.type|Portal.type]] — Portal. It's a part of the Portal System.
* Portal System \ [[Документация/Типы_объектов/Base/Zone.type|Zone.type]] — Зона. Часть портальной системы.
+
* Portal System \ [[Documentation/Entity_Types/Base/Zone.type|Zone.type]] — Zone. It's a part of the Portal System.
* Special \ [[Документация/Типы_объектов/Special/CutSceneManager.type|CutSceneManager.type]] — Управление сценами на движке.
+
* Special \ [[Documentation/Entity_Types/Special/CutSceneManager.type|CutSceneManager.type]] — Used to create cut-scenes.
 
* Special \ [[Документация/Типы_объектов/Special/HelperPoint.type|HelperPoint.type]] — Вспомогательная точка.
 
* Special \ [[Документация/Типы_объектов/Special/HelperPoint.type|HelperPoint.type]] — Вспомогательная точка.
 
* Special \ [[Документация/Типы_объектов/Special/MapChangeRegion.type|MapChangeRegion.type]] — Область перехода на другую карту.
 
* Special \ [[Документация/Типы_объектов/Special/MapChangeRegion.type|MapChangeRegion.type]] — Область перехода на другую карту.
* Special \ [[Документация/Типы_объектов/Base/MapCurve.type|MapCurve.type]] — Позволяет точками задать траекторию.
+
* Special \ [[Documentation/Entity_Types/Base/MapCurve.type|MapCurve.type]] — This type is used to set map paths (from point to point).
 
* Special \ [[Документация/Типы_объектов/Special/ObserveCameraArea.type|ObserveCameraArea.type]] — Область, в которой можно управлять положением камеры по заданной траектории.
 
* Special \ [[Документация/Типы_объектов/Special/ObserveCameraArea.type|ObserveCameraArea.type]] — Область, в которой можно управлять положением камеры по заданной траектории.
* Special \ [[Документация/Типы_объектов/Base/RenderableCurve.type|RenderableCurve.type]] — Позволяет рисовать кривые любой толщины и раскраски.
+
* Special \ [[Documentation/Entity_Types/Base/RenderableCurve.type|RenderableCurve.type]] — Allows you to create curves with any width, color and texture.
 
* Terrain \ [[Documentation/Entity_Types/Base/HeightmapTerrain.type|HeightmapTerrain.type]] — Heightmap-based landscape.
 
* Terrain \ [[Documentation/Entity_Types/Base/HeightmapTerrain.type|HeightmapTerrain.type]] — Heightmap-based landscape.
 
* Terrain \ [[Documentation/Entity_Types/Base/HeightmapTerrainManager.type|HeightmapTerrainManager.type]] — Heightmap-based landscape with streaming support.
 
* Terrain \ [[Documentation/Entity_Types/Base/HeightmapTerrainManager.type|HeightmapTerrainManager.type]] — Heightmap-based landscape with streaming support.
Line 107: Line 105:
 
XXXXXXXXXXXXXXXXXXXXXX
 
XXXXXXXXXXXXXXXXXXXXXX
  
 
 
=== Base Object Types ===
 
 
These entity types are considered as the engine base. It stored in the '''Data\Base\Types''' folder.
 
 
* [[Documentation/Entity_Types/Base/MapCamera.type|MapCamera.type]] — This type is used for setting cameras on the map.
 
* [[Documentation/Entity_Types/Base/MapCameraCurve.type|MapCameraCurve.type]] — This type allows you to create a camera path.
 
* [[Documentation/Entity_Types/Base/MapCompositorManager.type|MapCompositorManager.type]] — This type is used for setting up posteffects on the map.
 
* [[Documentation/Entity_Types/Base/MapCurve.type|MapCurve.type]] — This type is used to set map paths (from point to point).
 
* [[Documentation/Entity_Types/Base/Occluder.type|Occluder.type]] — Used for switching portals on and off. It's a part of the Portal System.
 
* [[Documentation/Entity_Types/Base/ParticleSystemSource.type|ParticleSystemSource.type]] — This type is used as a source of particles on the map.
 
* [[Documentation/Entity_Types/Base/Portal.type|Portal.type]] — Portal. It's a part of the Portal System.
 
* [[Documentation/Entity_Types/Base/Region.type|Region.type]] — An area you place on the map (can be used as triggers).
 
* [[Documentation/Entity_Types/Base/RenderableCurve.type|RenderableCurve.type]] — Allows you to create curves with any width, color and texture.
 
* [[Documentation/Entity_Types/Base/SkyBox.type|SkyBox.type]] — Sky, using a cubic texture.
 
* [[Documentation/Entity_Types/Base/SkyDome.type|SkyDome.type]] — Sky, using a hemisphere.
 
* [[Documentation/Entity_Types/Base/SoundSource.type|SoundSource.type]] — Sound source on the map.
 
* [[Documentation/Entity_Types/Base/StaticLightingManager.type|StaticLightingManager.type]] — Allows you to configure precalculated static lighting.
 
* [[Documentation/Entity_Types/Base/StaticMesh.type|StaticMesh.type]] — An object used for creating static geometry on the map.
 
* [[Documentation/Entity_Types/Base/Sun.type|Sun.type]] — Sun light source.
 
* [[Documentation/Entity_Types/Base/Zone.type|Zone.type]] — Zone. It's a part of the Portal System.
 
 
=== Object Types in SDK ===
 
 
The following entity types are frequently used but not considered as a part of the engine base. These entity types are stored in the '''Data\Types\Special''' folder.
 
 
* [[Documentation/Entity_Types/Special/CutSceneManager.type|CutSceneManager.type]] — Used to create cut-scenes.
 
 
* [[Documentation/Entity_Types/Special/Decal.type|Decal.type]] — Decals are used to render bullet holes, blood traces, explosion burns etc.
 
* [[Documentation/Entity_Types/Special/Decal.type|Decal.type]] — Decals are used to render bullet holes, blood traces, explosion burns etc.
 
* [[Documentation/Entity_Types/Special/CollisionVolume.type|CollisionVolume.type]] — This type is used to create invisible obstacles on the map.
 
* [[Documentation/Entity_Types/Special/CollisionVolume.type|CollisionVolume.type]] — This type is used to create invisible obstacles on the map.

Revision as of 22:07, 26 June 2015

Go to higher level

Contents

Articles for NeoAxis 3D Engine

Getting Started

Toolset

Tutorials

Export Models from Modeling Packages

Components

Performance Optimization

Object Types

In the Map Editor each object have ti's own type. You will find here a list of the base object types available in the SDK. In addition to theses base types, you can create your own type of objects and place them in the Map Editor.

Base object on the map: Map — Map object. This type is automatically created with a new map and can't be deleted.

Basic types:


XXXXXXXXXXXXXXXXXXXXXX

Programming Articles

Articles

Various

Tutorials

Third-Party Tutorials

Additional

Old Articles to Update