RealXtend Tundra SDK Documentation

Introduction

Welcome to the Tundra developer documentation. This page is a site map that assembles together all the major features offered by Tundra.

Download Obtain Tundra from A binary distribution (Windows and Mac). Nightly developer builds (Windows) from the LudoCraft fork. Source repository on github. Binary dependencies repository on Google code. Tundra distribution license.

Getting Started Follow these first steps. Building and Running Tundra on Windows. Building and Running Tundra on Ubuntu 11.10. Building and Running Tundra on Mac OS X. Configuring and Running Tundra.

Community Contact Tundra developers and users at Developer mailing list. End-user mailing list. IRC channels: #realxtend and #realxtend-dev on freenode. Bug tracker: github

Technical Resources See the following pages for help on working on the Tundra codebase. Coding conventions. Header usage best practices. Tundra Architecture Overview. Entity-Component reference. Tundra scripting reference. Working with Tundra document files. Setting up Mumble VOIP. Setting up an http asset storage with WebDAV. Documentations of major external libraries used with Tundra: Qt documentation. Ogre documentation. kNet documentation. Game Math and Geometry Library. Tundra and Security

The functionality built into Tundra is subdivided into core libraries and optional subsystems. The core libraries are sets of APIs that each expose some functionality of the Tundra system to native C++ code or scripted modules or scene entities. These interfaces are accessible directly through the root Framework object. The individual subsystems are accessible by querying the appropriate modules using the Module API.

The root object for accessing all Tundra features is the Framework object. This object drives the main loop and gives access of all the core APIs to modules and scripts. For more information, see

• the Framework class.
• Tundra Frame API.

Core

The Tundra SDK consists of the following set of core APIs that are accessible from client modules, components and scripts.

Module The Module API gives access to all the modules registered in the system. For working with modules, see the following topics: Accessing modules in your code. Creating a new module using C++. Creating a new module using Python. Setting up cmake files and PCHs for your module. Module definition file and load orders. Supporting localization in your module. Classes: Framework IModule	Event The Qt's signals and slots mechanism is used for communication between objects.
Config Implements a uniform mechanism for modules to store their configuration data. Main documentation page. More information: Reading and writing configuration data. Using default values. Classes: ConfigAPI ConfigData	Debug Contains useful development-time mechanisms like memory tracking and execution time profiling. Topics: Detecting memory leaks. Using the Tundra execution time profiler. Performing automated network testing. Classes: Profiler ProfilerBlock
Input Provides access to Qt input devices in a contextual order. InputAPI is available as 'input' in Javascript and 'tundra.input' in Python. Follow these topics to learn more: Reading input through an InputContext. Providing reconfigurable key bindings with keyboard mappings. InputContext priorities and playing nice with Qt. Polling for input. Classes: InputAPI InputContext KeyEvent MouseEvent	UI Exposes the Tundra main window and allows clients to create and show their own Qt-based windows. UiAPI is available as 'ui' in Javascript and 'tundra.ui' in Python. Classes: UiAPI UiMainWindow UiGraphicsView UiProxyWidget
Scene Gives access to the Tundra 3D scene structure: entities, components and attributes. SceneAPI is available as 'scene' in Javascript and 'tundra.scene' in Python. Topics: Scenes, entities and components. Attributes and attribute metadata. Entity actions. Accessing scene contents from C++ code. Working with multiple scenes. Accessing entity attributes using JavaScript. Accessing entity attributes using Python. Creating new component types. Creating new attribute types. Entity attribute replication model. Classes: SceneAPI Scene Entity EntityAction IComponent IAttribute AttributeMetadata	Asset Implements the Tundra asset system and a pluggable asset provider architecture for streaming in asset data files. For more information, see Setting up an http asset storage with WebDAV. Assets on localhost. HTTP asset provider. Implementing a new asset provider plugin. Tundra asset cache structure. Classes: AssetAPI ...
Console Allows modules to register new commands that are invokeable from a command line console. Also provides logging mechanism for dynamic languages. ConsoleAPI is available as 'console' in Javascript and 'tundra.console' in Python with the support for: Registering new console commands. Programmatically invoking console commands. Classes: ConsoleAPI ConsoleCommand	Connection Exposes the functionality related to the currently active server connection, if Tundra is connected to a server. Classes: TundraLogic::TundraLogicModule TundraLogic::Client UserConnection
Server If Tundra is acting as a network server, this interface can be accessed to interact with the currently active client connections. Classes: TundraLogic::TundraLogicModule TundraLogic::Server UserConnection	Audio Provides functions for playing back audio on the client. Main documentation page. Topics: Using the sound system. todo: add here the concepts related to audio. Classes: AudioAPI ...
Frame Exposes signals for frame- and time-related event processing. Topics: Executing per-frame processing. Delayed one-time execution. Periodic execution. The Frame API is accessed through the class FrameAPI. Classes: FrameAPI DelayedSignal

Tundra Scene Structure

The most visible part of Tundra to end-users and world builders is the Tundra scene structure. The Scene API is used to access this scene in program code. The Tundra Entity Component Reference page contains a reference documentation for all the components that make up a scene.

Subsystems

In addition to providing the core API, Tundra contains the following functional subsystems, implemented as sets of modules.

Renderer This subsystem consists of the rendering library and the graphics-related Tundra scene features. See the following topics for more information: Using the Ogre renderer module. Implemented by modules OgreRenderer::OgreRenderingModule Exposes the components EC_Placeable, EC_Mesh, EC_Light, EC_ParticleSystem, EC_AnimationController, EC_Camera, EC_Material, EC_OgreCompositor, EC_RttTarget. EnvironmentModule Exposes the components EC_Sky, EC_Terrain, EC_WaterPlane, EC_Fog. SkyXHydrax Exposes the components EC_SkyX and EC_Hydrax.

Physics Physics simulation using Bullet. Implemented by modules Physics::PhysicsModule Exposes the components EC_RigidBody, EC_VolumeTrigger.

Script Allows implementing modules using the Python script language as well as embedding new functionality into scene entities by using JavaScript or Python. Implemented by modules and components PythonScript::PythonScriptModule JavascriptModule EC_Script EC_DynamicComponent

Communication The subsystem of Tundra that provides video and audio communication features between clients connected to the world. See the following topics for more information: Setting up Mumble VOIP. Implemented by modules MumbleVoip::MumbleVoipModule VlcPlugin