TimelineScale

Inherits Scale

This Scale uses a timeline of other Scale classes to calculate the final scale factor for the attached scene graph node. The current in-game time is used to determine which specific keyframe to currently use. It is also possible to interpolate between two adjacent keyframes.

Members

Name	Documentation	Type	Description	Optional
Keyframes	A table of keyframes, with keys formatted as YYYY-MM-DDTHH:MM:SS and values that are valid Scale objects.	Table	Table parameters	No
ShouldInterpolate	If this value is set to ‘true’, an interpolation is applied between the given keyframes. If this value is set to ‘false’, the interpolation is not applied.	Boolean	Value of type ‘Boolean’	Yes

Inherited members from Scale

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

Table parameters for Keyframes

A table of keyframes, with keys formatted as YYYY-MM-DDTHH:MM:SS and values that are valid Scale objects.

• Optional: No

Name	Documentation	Type	Description	Optional
*		Table	Scale	No

Asset Examples

No Interpolation

This asset creates a scene graph node that only displays coordinate axes. The scale of the coordinate axes are determined by a timeline of individual scales that are used without interpolating between the timeline entries. These scales are keyframes that are used to change between different sizes. This example transitions between three sizes. In this example, the interpolation between entries is disabled, which will cause the coordinate axes to change their size abruptly when the scale changes. If the interpolation were enabled, the orientation of the coordinate axes would transition seamlessly instead at the provided times. This example will only work if the in-game time is set to January 1st, 2000.

local Node = {
  Identifier = "TimelineScale_Example_NoInterpolation",
  Transform = {
    Scale = {
      Type = "TimelineScale",
      Keyframes = {
        -- The first timeline entry
        ["2000 JAN 01 00:00:00"] = {
          Type = "StaticScale",
          Scale = 20.0
        },
        -- The second timeline entry
        ["2000 JAN 01 12:00:00"] = {
          Type = "StaticScale",
          Scale = 10.0
        },
        -- The third timeline entry
        ["2000 JAN 01 23:59:59"] = {
          Type = "StaticScale",
          Scale = 20.0
        }
      },
      ShouldInterpolate = false
    }
  },
  Renderable = {
    Type = "RenderableCartesianAxes"
  },
  GUI = {
    Name = "TimelineScale - No Interpolation",
    Path = "/Examples"
  }
}

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

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

No Interpolation

This asset creates a scene graph node that only displays coordinate axes whose scale is determined by a timeline of individual scales that are used without interpolating between the timeline entries. These scales are keyframes that are used to change between different sizes.

This example transitions between three sizes, but as the interpolation between entries is disabled, it will cause the coordinate axes to change their size abruptly when the scale changes. If the interpolation were enabled, the orientation of the coordinate axes would transition seamlessly instead at the provided times. This example will only work if the in-game time is set to January 1st, 2000.

local Node = {
  Identifier = "TimelineScale_Example_NoInterpolation",
  Transform = {
    Scale = {
      Type = "TimelineScale",
      Keyframes = {
        -- The first timeline entry
        ["2000 JAN 01 00:00:00"] = {
          Type = "StaticScale",
          Scale = 10.0
        },
        -- The second timeline entry
        ["2000 JAN 01 12:00:00"] = {
          Type = "StaticScale",
          Scale = 0.0
        },
        -- The third timeline entry
        ["2000 JAN 01 23:59:59"] = {
          Type = "StaticScale",
          Scale = -10.0
        }
      },
      ShouldInterpolate = false
    }
  },
  Renderable = {
    Type = "RenderableCartesianAxes"
  },
  GUI = {
    Name = "TimelineScale - No Interpolation",
    Path = "/Examples"
  }
}

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

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

Basic

This asset creates a scene graph node that only displays coordinate axes. The scale of the coordinate axes are determined by a timeline of individual scales. These scales are keyframes that are used to seamlessly change between different sizes. This example transitions between three scales over a long time span. This example will only work if the in-game time is set to January 1st, 2000.

local Node = {
  Identifier = "TimelineScale_Example",
  Transform = {
    Scale = {
      Type = "TimelineScale",
      Keyframes = {
        -- The first timeline entry
        ["2000 JAN 01 00:00:00"] = {
          Type = "StaticScale",
          Scale = 10.0
        },
        -- The second timeline entry
        ["2000 JAN 01 12:00:00"] = {
          Type = "StaticScale",
          Scale = 0.0
        },
        -- The third timeline entry
        ["2000 JAN 01 23:59:59"] = {
          Type = "StaticScale",
          Scale = -10.0
        }
      }
    }
  },
  Renderable = {
    Type = "RenderableCartesianAxes"
  },
  GUI = {
    Name = "TimelineScale - Basic",
    Path = "/Examples"
  }
}

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

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