RenderableCartesianAxes

Inherits Renderable

The RenderableCartesianAxes can be used to render the local Cartesian coordinate system, or reference frame, of another scene graph node. The colors of the axes can be customized but are per default set to Red, Green and Blue, for the X-, Y- and Z-axis, respectively.

To add the axes, create a scene graph node with the RenderableCartesianAxes renderable and add it as a child to the other scene graph node, i.e. specify the other node as the Parent of the node with this renderable. Also, the axes have to be scaled to match the parent object for the axes to be visible in the scene, for example using a StaticScale.

Members

Name

Documentation

Type

Description

Optional

XColor

The color of the x-axis.

Color3

Value of type ‘Color3’

Yes

YColor

The color of the y-axis.

Color3

Value of type ‘Color3’

Yes

ZColor

The color of the z-axis.

Color3

Value of type ‘Color3’

Yes

Inherited members from Renderable

Name

Documentation

Type

Description

Optional

DimInAtmosphere

Decides if the object should be dimmed (i.e. faded out) when the camera is in the sunny part of an atmosphere.

Boolean

Value of type ‘Boolean’

Yes

Enabled

Determines whether this object will be visible or not.

Boolean

Value of type ‘Boolean’

Yes

Opacity

This value determines the opacity of this renderable. A value of 0 means completely transparent

Double

In range: ( 0,1 )

Yes

RenderBinMode

A value that specifies if the renderable should be rendered in the Background, Opaque, Pre-/PostDeferredTransparency, Overlay, or Sticker rendering step.

String

In list { Background, Opaque, PreDeferredTransparent, PostDeferredTransparent, Overlay }

Yes

Tag

A single tag or a list of tags that this renderable will respond to when setting properties

Table, or String

Value of type ‘Table’, or Value of type ‘String’

Yes

Type

The type of the renderable.

String

Value of type ‘String’

Yes

Asset Examples

Basic

This asset creates a SceneGraphNode that only displays coordinate axes. The parent is not set which defaults to placing the axes at the center the Sun.

 1local Node = {
 2  Identifier = "RenderableCartesianAxes_Example",
 3  Transform = {
 4    Scale = {
 5      Type = "StaticScale",
 6      Scale = 30000000
 7    }
 8  },
 9  Renderable = {
10    Type = "RenderableCartesianAxes"
11  },
12  GUI = {
13    Name = "RenderableCartesianAxes - Basic",
14    Path = "/Examples"
15  }
16}
17
18asset.onInitialize(function()
19  openspace.addSceneGraphNode(Node)
20end)
21
22asset.onDeinitialize(function()
23  openspace.removeSceneGraphNode(Node)
24end)