Documentation

From NeoAxis 3D Engine Wiki

(Difference between revisions)
Jump to: navigation, search
Line 60: Line 60:
  
 
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.
 +
 +
 +
 +
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 \ [[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/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 \ [[Документация/Типы_объектов/Base/ParticleSystemSource.type|ParticleSystemSource.type]] — Позволяет расставлять источники частиц на карте.
 +
* Basic \ [[Документация/Типы_объектов/Base/Region.type|Region.type]] — Область на карте.
 +
* Basic \ [[Документация/Типы_объектов/Base/SkyBox.type|SkyBox.type]] — Небо в виде статичной кубической карты.
 +
* Basic \ [[Документация/Типы_объектов/Base/SkyDome.type|SkyDome.type]] — Небо в виде полусферы.
 +
* Basic \ [[Документация/Типы_объектов/Base/SoundSource.type|SoundSource.type]] — Источник звука на карте.
 +
* Basic \ [[Документация/Типы_объектов/Special/SpawnPoint.type|SpawnPoint.type]] — Стартовая точка.
 +
* Basic \ [[Документация/Типы_объектов/Base/StaticMesh.type|StaticMesh.type]] — Объект для создания статичной геометрии на карте.
 +
* Camera \ [[Документация/Типы_объектов/Base/MapCamera.type|MapCamera.type]] — Позволяет расставлять камеры на карте.
 +
* Camera \ [[Документация/Типы_объектов/Base/MapCameraCurve.type|MapCameraCurve.type]] — Позволяет задавать траекторию полета камеры.
 +
* 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/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 \ [[Документация/Типы_объектов/Base/StaticLightingManager.type|StaticLightingManager.type]] — Менеджер статичного освещения.
 +
* Lighting \ [[Документация/Типы_объектов/Base/Sun.type|Sun.type]] — Солнце.
 +
* Pathfinding \ [[Документация/Типы_объектов/Special/GridBasedNavigationSystem.type|GridBasedNavigationSystem.type]] — Система поиска пути на базе двумерной сетки.
 +
* Pathfinding \ [[Документация/Типы_объектов/Special/RecastNavigationSystem.type|RecastNavigationSystem.type]] — Система поиска пути на базе технологии Navigation Mesh.
 +
* Portal System \ [[Документация/Типы_объектов/Base/Occluder.type|Occluder.type]] — Служит для выключения порталов. Часть портальной системы.
 +
* Portal System \ [[Документация/Типы_объектов/Base/Portal.type|Portal.type]] — Портал. Часть портальной системы.
 +
* Portal System \ [[Документация/Типы_объектов/Base/Zone.type|Zone.type]] — Зона. Часть портальной системы.
 +
* Special \ [[Документация/Типы_объектов/Special/CutSceneManager.type|CutSceneManager.type]] — Управление сценами на движке.
 +
* Special \ [[Документация/Типы_объектов/Special/HelperPoint.type|HelperPoint.type]] — Вспомогательная точка.
 +
* Special \ [[Документация/Типы_объектов/Special/MapChangeRegion.type|MapChangeRegion.type]] — Область перехода на другую карту.
 +
* Special \ [[Документация/Типы_объектов/Base/MapCurve.type|MapCurve.type]] — Позволяет точками задать траекторию.
 +
* Special \ [[Документация/Типы_объектов/Special/ObserveCameraArea.type|ObserveCameraArea.type]] — Область, в которой можно управлять положением камеры по заданной траектории.
 +
* Special \ [[Документация/Типы_объектов/Base/RenderableCurve.type|RenderableCurve.type]] — Позволяет рисовать кривые любой толщины и раскраски.
 +
* 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.
 +
* Water Plane \ [[Documentation/Entity_Types/Special/WaterPlane.type|WaterPlane.type]] — This type is used for creating water surfaces.
 +
* Water Plane \ [[Documentation/Entity_Types/Special/WaterPlaneClipVolume.type|WaterPlaneClipVolume.type]] — Additional type for WaterPlane to control reflection's generation.
 +
 +
 +
 +
XXXXXXXXXXXXXXXXXXXXXX
 +
 +
  
 
=== Base Object Types ===
 
=== Base Object Types ===
Line 65: Line 113:
 
These entity types are considered as the engine base. It stored in the '''Data\Base\Types''' folder.
 
These entity types are considered as the engine base. It stored in the '''Data\Base\Types''' folder.
  
* [[Documentation/Entity_Types/Base/CubemapZone.type|CubemapZone.type]] — Used to generate a cubemap texture of the environment.
 
* [[Documentation/Entity_Types/Base/CubemapZone_BoxParallaxCorrectedZone.type|CubemapZone_BoxParallaxCorrectedZone.type]] — Used to correct rendering reflections from cubemaps (CubemapZone.type).
 
* [[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.
 
* [[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.
 
* [[Documentation/Entity_Types/Base/Fog.type|Fog.type]] — Fog.
 
* [[Documentation/Entity_Types/Base/HeightmapTerrain.type|HeightmapTerrain.type]] — Heightmap-based landscape.
 
* [[Documentation/Entity_Types/Base/HeightmapTerrainManager.type|HeightmapTerrainManager.type]] — Heightmap-based landscape with streaming support.
 
* [[Documentation/Entity_Types/Base/LensFlareManager.type|LensFlareManager.type]] — The manager to manage lens flares from the Sun light source.
 
* [[Documentation/Entity_Types/Base/Light.type|Light.type]] — Light source.
 
* [[Documentation/Entity_Types/Base/Map.type|Map.type]] — Map object. This type is automatically created with a new map.
 
 
* [[Documentation/Entity_Types/Base/MapCamera.type|MapCamera.type]] — This type is used for setting cameras on the map.
 
* [[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/MapCameraCurve.type|MapCameraCurve.type]] — This type allows you to create a camera path.
Line 106: Line 144:
 
* [[Documentation/Entity_Types/Special/GridBasedNavigationSystem.type|GridBasedNavigationSystem.type]] — Pathfinding system based on the grid.
 
* [[Documentation/Entity_Types/Special/GridBasedNavigationSystem.type|GridBasedNavigationSystem.type]] — Pathfinding system based on the grid.
 
* [[Documentation/Entity_Types/Special/SpawnPoint.type|SpawnPoint.type]] — Spawn point for the player (or another units).
 
* [[Documentation/Entity_Types/Special/SpawnPoint.type|SpawnPoint.type]] — Spawn point for the player (or another units).
* [[Documentation/Entity_Types/Special/WaterPlane.type|WaterPlane.type]] — This type is used for creating water surfaces.
 
* [[Documentation/Entity_Types/Special/WaterPlaneClipVolume.type|WaterPlaneClipVolume.type]] — Additional type for WaterPlane to control reflection's generation.
 
  
 
== Programming Articles ==
 
== Programming Articles ==

Revision as of 21:51, 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.


XXXXXXXXXXXXXXXXXXXXXXXXXXXX Map.type — Map object. This type is automatically created with a new map.


  • Basic \ CollisionVolume.type — Невидимое ограничивающее препятствие.
  • Basic \ DecorativeObjectManager.type — This type allows you to create a large amount of objects (like grass, trees, rocks)to quickly populate your map.
  • Basic \ Fog.type — Fog.
  • Basic \ GeneralMapObject.type — The object on the map without behaviour. This object can be used to configure by means components.
  • Basic \ MapCompositorManager.type — Позволяет добавлять на карту пост-эффекты.
  • Basic \ ParticleSystemSource.type — Позволяет расставлять источники частиц на карте.
  • Basic \ Region.type — Область на карте.
  • Basic \ SkyBox.type — Небо в виде статичной кубической карты.
  • Basic \ SkyDome.type — Небо в виде полусферы.
  • Basic \ SoundSource.type — Источник звука на карте.
  • Basic \ SpawnPoint.type — Стартовая точка.
  • Basic \ StaticMesh.type — Объект для создания статичной геометрии на карте.
  • Camera \ MapCamera.type — Позволяет расставлять камеры на карте.
  • Camera \ MapCameraCurve.type — Позволяет задавать траекторию полета камеры.
  • Lighting \ CubemapZone.type — Used to generate a cubemap texture of the environment.
  • Lighting \ CubemapZone_BoxParallaxCorrectedZone.type — Used to correct rendering reflections from cubemaps (CubemapZone.type).
  • Lighting \ LensFlareManager.type — The manager to manage lens flares from the Sun light source.
  • Lighting \ Light.type — Light source.
  • Lighting \ StaticLightingManager.type — Менеджер статичного освещения.
  • Lighting \ Sun.type — Солнце.
  • Pathfinding \ GridBasedNavigationSystem.type — Система поиска пути на базе двумерной сетки.
  • Pathfinding \ RecastNavigationSystem.type — Система поиска пути на базе технологии Navigation Mesh.
  • Portal System \ Occluder.type — Служит для выключения порталов. Часть портальной системы.
  • Portal System \ Portal.type — Портал. Часть портальной системы.
  • Portal System \ Zone.type — Зона. Часть портальной системы.
  • Special \ CutSceneManager.type — Управление сценами на движке.
  • Special \ HelperPoint.type — Вспомогательная точка.
  • Special \ MapChangeRegion.type — Область перехода на другую карту.
  • Special \ MapCurve.type — Позволяет точками задать траекторию.
  • Special \ ObserveCameraArea.type — Область, в которой можно управлять положением камеры по заданной траектории.
  • Special \ RenderableCurve.type — Позволяет рисовать кривые любой толщины и раскраски.
  • Terrain \ HeightmapTerrain.type — Heightmap-based landscape.
  • Terrain \ HeightmapTerrainManager.type — Heightmap-based landscape with streaming support.
  • Water Plane \ WaterPlane.type — This type is used for creating water surfaces.
  • Water Plane \ WaterPlaneClipVolume.type — Additional type for WaterPlane to control reflection's generation.


XXXXXXXXXXXXXXXXXXXXXX


Base Object Types

These entity types are considered as the engine base. It stored in the Data\Base\Types folder.

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.

Programming Articles

Articles

Various

Tutorials

Third-Party Tutorials

Additional

Old Articles to Update