Skip to content

skybolt

Python API for accessing Skybolt Engine C++ functionality.

Attributes

LoadAcrossMultipleFrames: LoadTimingPolicy module-attribute

LoadBeforeRender: LoadTimingPolicy module-attribute

Classes

Box3d

Attributes
maximum: Vector3 instance-attribute
minimum: Vector3 instance-attribute
Functions
center()
merge(arg0)
size()

CameraComponent

Bases: Component

Attributes
state: CameraState instance-attribute

CameraControllerComponent

Bases: Component, CameraControllerSelector

CameraControllerSelector

Functions
getSelectedControllerName()
selectController(arg0)
setTargetId(arg0)

CameraState

Attributes
farClipDistance: float instance-attribute
fovY: float instance-attribute
nearClipDistance: float instance-attribute

Component

Base class for components which can be attached to an Entity

Functions
setSimTime(arg0)

EngineRoot

Attributes
entityFactory: EntityFactory property
scenario: Scenario property
world: World property
Functions
locateFile(arg0)

Entity

Attributes
dynamicsEnabled: bool instance-attribute
Functions
addComponent(arg0)
getComponents()
getComponentsOfType(arg0)
getFirstComponentOfType(arg0)
getId()
getName()
getOrientation()
getPosition()
setOrientation(arg0)
setPosition(arg0)

EntityFactory

Class responsible for creating Entity instances based on a template name

Functions
createEntity(templateName, name='', position=..., orientation=..., id=...)

EntityId

Attributes
applicationId: int instance-attribute
entityId: int instance-attribute

EntityTargeter

Interface for a class which references a target Entity by EntityId

Functions
getTargetId()
getTargetName()
setTargetId(arg0)
setTargetName(arg0)

Frustum

Attributes
fieldOfViewHorizontal: float instance-attribute
fieldOfViewVertical: float instance-attribute
orientation: Quaternion instance-attribute
origin: Vector3 instance-attribute

GeocentricOrientation

Bases: Orientation

Attributes
orientation: Quaternion instance-attribute

GeocentricPosition

Bases: Position

Attributes
position: Vector3 instance-attribute

LatLon

Represents a 2D location on a planet location as a latitude and longitude in radians

Attributes
lat: float instance-attribute
lon: float instance-attribute

LatLonAlt

Represents a 3D location on a planet location as a latitude and longitude in radians, and altitude in meters

Attributes
alt: float instance-attribute
lat: float instance-attribute
lon: float instance-attribute

LatLonAltPosition

Bases: Position

Attributes
position: LatLonAlt instance-attribute

LoadTimingPolicy

Enum specifying policy for timing of loading data into the renderer

Members:

LoadAcrossMultipleFrames

LoadBeforeRender

Attributes
LoadAcrossMultipleFrames: LoadTimingPolicy class-attribute
LoadBeforeRender: LoadTimingPolicy class-attribute
name: str property
value: int property

LtpNedOrientation

Bases: Orientation

Attributes
orientation: Quaternion instance-attribute

MainRotorComponent

Bases: Component

Functions
getPitchAngle()
getRotationAngle()
getTppOrientationRelBody()
setNormalizedRpm(arg0)

OffscreenWindow

Bases: Window

Orientation

Position

Quaternion

Represents an orientation as a quarternion of [x, y, z, w] components

Attributes
w: float instance-attribute
x: float instance-attribute
y: float instance-attribute
z: float instance-attribute

RectI

A rectangle defined by [x, y, width, height]

Scenario

Attributes
currentJulianDate: float property
startJulianDate: float instance-attribute
time: float instance-attribute

ScenarioMetadataComponent

Bases: Component

Attributes
deletable: bool instance-attribute
directory: VectorString instance-attribute
serializable: bool instance-attribute

StandaloneWindow

Bases: Window

TemplateNameComponent

Bases: Component

A component storing the name of the template which an Entity instantiates

Attributes
name: str property

Vector3

A 3D vector of [x, y, z] components

Attributes
x: float instance-attribute
y: float instance-attribute
z: float instance-attribute

VectorString

Functions
append(x)

Add an item to the end of the list

clear()

Clear the contents

count(x)

Return the number of times x appears in the list

insert(i, x)

Insert an item at a given position.

remove(x)

Remove the first item from the list whose value is x. It is an error if there is no such item.

VisRoot

Functions
addWindow(arg0)
removeWindow(arg0)
setLoadTimingPolicy(arg0)

Window

World

Functions
addEntity(arg0)
findObjectByName(arg0)
getEntities()
removeAllEntities()
removeEntity(arg0)

Functions

attachCameraToWindowWithEngine(arg0, arg1, arg2)

calcSmallestAngleFromTo(arg0, arg1)

createEngineRootWithDefaults()

Create an EngineRoot with default values

cross(arg0, arg1)

dot(arg0, arg1)

getGlobalEngineRoot()

Get global EngineRoot

moveDistanceAndBearing(arg0, arg1, arg2)

normalize(arg0)

quaternionFromEuler(arg0)

registerComponent(arg0, arg1)

render(engineRoot, window)

setGlobalEngineRoot(arg0)

Set global EngineRoot

setWaveHeight(arg0, arg1)

stepSim(arg0, arg1)

toGeocentricOrientation(arg0, arg1)

toGeocentricPosition(arg0)

toLatLon(arg0)

transformToScreenSpace(arg0, arg1)