GlobeRotation

Inherits Rotation

This Rotation orients the scene graph node in such a way that the y-axis points away from the provided globe, the x-axis points towards the globe’s southern pole and the z-axis points in a western direction. Using this rotation generally means using the GlobeTranslation to place the scene graph node at the same position for which the rotation is calculated.

Members

Name	Documentation	Type	Description	Optional
Globe	The node on which the longitude/latitude is specified. If the node is a globe, the correct height information for the globe is used. Otherwise, the position is specified based on the longitude and latitude on the node’s interaction sphere	Identifier	An identifier string. May not contain ‘.’, spaces, newlines, or tabs	No
Latitude	The latitude of the location on the globe’s surface. The value can range from -90 to 90, with negative values representing the southern hemisphere of the globe.	Double	In range: ( -90,90 )	No
Longitude	The longitude of the location on the globe’s surface. The value can range from -180 to 180, with negative values representing the western hemisphere of the globe.	Double	In range: ( -180,180 )	No
Angle	A rotation angle (in degrees) that can be used to rotate the object around its own y-axis, which will be pointing out of the globe’s surface.	Double	Value of type ‘Double’	Yes
UseCamera	If this value is ‘true’, the latitute and longitude are updated each frame to match the location of the camera.	Boolean	Value of type ‘Boolean’	Yes
UseHeightmap	If set to true, the heightmap will be used when computing the surface normal. This means that the object will be rotated to lay flat on the surface at the given coordinate and follow the shape of the landscape.	Boolean	Value of type ‘Boolean’	Yes

Inherited members from Rotation

Name	Documentation	Type	Description	Optional
Type	The type of the rotation that is described in this element. The available types of rotations depend on the configuration of the application and can be written to disk on application startup into the FactoryDocumentation	String	Must name a valid Rotation type	No
TimeFrame	The time frame in which this Rotation is applied. If the in-game time is outside this range, no rotation will be applied.	Table	TimeFrame	Yes

Asset Examples

UseCamera

This asset creates a rotation that places a coordinate axes on the surface of a planetary body. The rotation causes the coordinate axes to remain fixed to the surface of the globe. In this example, the rotation of the object will be updated based on the location of the camera. When loading this example, make sure to focus the camera on the Globe object for the follow-function to work.

In order for this feature to work properly, the coordinate axes need to be located at the same place as well, so this example also needs a GlobeTranslation applied, which in this case also updated based on the camera location.

-- The example needs a `RenderableGlobe` as a parent to function
local Globe = {
  Identifier = "GlobeRotation_Example_UseCamera_Globe",
  Renderable = {
    Type = "RenderableGlobe"
  },
  GUI = {
    Name = "GlobeRotation - UseCamera (Globe)",
    Path = "/Examples"
  }
}

local Node = {
  Identifier = "GlobeRotation_Example_UseCamera",
  Parent = "GlobeRotation_Example_UseCamera_Globe",
  Transform = {
    Translation = {
      Type = "GlobeTranslation",
      Globe = "GlobeRotation_Example_UseCamera_Globe",
      Latitude = 20.0,
      Longitude = -45.0,
      UseCamera = true
    },
    Rotation = {
      Type = "GlobeRotation",
      Globe = "GlobeRotation_Example_UseCamera_Globe",
      Latitude = 20.0,
      Longitude = -45.0,
      Angle = 45.0,
      UseCamera = true
    }
  },
  Renderable = {
    Type = "RenderableCartesianAxes"
  },
  GUI = {
    Name = "GlobeRotation - UseCamera",
    Path = "/Examples"
  }
}

asset.onInitialize(function()
  openspace.addSceneGraphNode(Globe)
  openspace.addSceneGraphNode(Node)
end)

asset.onDeinitialize(function()
  openspace.removeSceneGraphNode(Node)
  openspace.removeSceneGraphNode(Globe)
end)

Basic

This asset creates a rotation that places a coordinate axes on the surface of a planetary body. The rotation causes the coordinate axes to remain fixed to the surface of the globe.

In order for this feature to work properly, the coordinate axes need to be located at the same place as well, so this example also needs a GlobeTranslation applied.

-- The example needs a `RenderableGlobe` as a parent to function
local Globe = {
  Identifier = "GlobeRotation_Example_Globe",
  Renderable = {
    Type = "RenderableGlobe"
  },
  GUI = {
    Name = "GlobeRotation - Basic (Globe)",
    Path = "/Examples"
  }
}

local Node = {
  Identifier = "GlobeRotation_Example",
  Parent = "GlobeRotation_Example_Globe",
  Transform = {
    Translation = {
      Type = "GlobeTranslation",
      Globe = "GlobeRotation_Example_Globe",
      Latitude = 20.0,
      Longitude = -45.0
    },
    Rotation = {
      Type = "GlobeRotation",
      Globe = "GlobeRotation_Example_Globe",
      Latitude = 20.0,
      Longitude = -45.0
    }
  },
  Renderable = {
    Type = "RenderableCartesianAxes"
  },
  GUI = {
    Name = "GlobeRotation - Basic",
    Path = "/Examples"
  }
}

asset.onInitialize(function()
  openspace.addSceneGraphNode(Globe)
  openspace.addSceneGraphNode(Node)
end)

asset.onDeinitialize(function()
  openspace.removeSceneGraphNode(Node)
  openspace.removeSceneGraphNode(Globe)
end)

Angle

This asset creates a rotation that places a coordinate axes on the surface of a planetary body. The rotation causes the coordinate axes to remain fixed to the surface of the globe. Additionally, the coordinate axes are rotated around the up-axis by a fixed amount.

In order for this feature to work properly, the coordinate axes need to be located at the same place as well, so this example also needs a GlobeTranslation applied.

-- The example needs a `RenderableGlobe` as a parent to function
local Globe = {
  Identifier = "GlobeRotation_Example_Angle_Globe",
  Renderable = {
    Type = "RenderableGlobe"
  },
  GUI = {
    Name = "GlobeRotation - Angle (Globe)",
    Path = "/Examples"
  }
}

local Node = {
  Identifier = "GlobeRotation_Example_Angle",
  Parent = "GlobeRotation_Example_Angle_Globe",
  Transform = {
    Translation = {
      Type = "GlobeTranslation",
      Globe = "GlobeRotation_Example_Angle_Globe",
      Latitude = 20.0,
      Longitude = -45.0
    },
    Rotation = {
      Type = "GlobeRotation",
      Globe = "GlobeRotation_Example_Angle_Globe",
      Latitude = 20.0,
      Longitude = -45.0,
      Angle = 45.0
    }
  },
  Renderable = {
    Type = "RenderableCartesianAxes"
  },
  GUI = {
    Name = "GlobeRotation - Angle",
    Path = "/Examples"
  }
}

asset.onInitialize(function()
  openspace.addSceneGraphNode(Globe)
  openspace.addSceneGraphNode(Node)
end)

asset.onDeinitialize(function()
  openspace.removeSceneGraphNode(Node)
  openspace.removeSceneGraphNode(Globe)
end)