RenderableStars
Inherits Renderable
Members
Name |
Documentation |
Type |
Description |
Optional |
---|---|---|---|---|
|
The path to the texture that is used to convert from the B-V value of the star to its color. The texture is used as a one dimensional lookup function |
|
Value of type ‘File’ |
No |
|
The mappings between data values and the variable names specified in the speck file |
|
No |
|
|
The path to the SPECK file containing information about the stars being rendered |
|
Value of type ‘File’ |
No |
|
Render method for the stars |
|
In list { PSF, Texture Based } |
No |
|
The path to the texture that should be used as a point spread function for the stars |
|
Value of type ‘File’ |
No |
|
This value determines which quantity is used for determining the color of the stars |
|
In list { Color, Velocity, Speed, Other Data, Fixed Color } |
Yes |
|
Enables/Disables the Fade-in effect |
|
Value of type ‘Boolean’ |
Yes |
|
These values determine the initial and final distances from the center of our galaxy from which the astronomical object will start and end fading-in |
|
Value of type ‘Vector2 |
Yes |
|
Determines whether other data values outside the value range should be visible or filtered away |
|
Value of type ‘Boolean’ |
Yes |
|
Adjust star magnitude by 10^MagnitudeExponent. Stars closer than this distance are given full opacity. Farther away, stars dim proportionally to the logarithm of their distance |
|
Value of type ‘Double’ |
Yes |
|
The index of the speck file data column that is used as the color input |
|
Value of type ‘String’ |
Yes |
|
The color map that is used if the ‘Other Data’ rendering method is selected |
|
Value of type ‘String’ |
Yes |
|
Base multiplyer for the final stars’ sizes |
|
In list { App Brightness, Lum and Size, Lum, Size and App Brightness, Abs Magnitude, App Magnitude, Distance Modulus } |
Yes |
|
This value specifies a value that is always filtered out of the value ranges on loading. This can be used to trim the dataset’s automatic value range |
|
Value of type ‘Double’ |
Yes |
|
This is the value that is used to replace statically filtered values. Setting this value only makes sense if ‘StaticFilter’ is ‘true’, as well |
|
Value of type ‘Double’ |
Yes |
Inherited members from Renderable
Name |
Documentation |
Type |
Description |
Optional |
---|---|---|---|---|
|
Enables/Disables if the object should be dimmed when the camera is in the sunny part of an atmosphere |
|
Value of type ‘Boolean’ |
Yes |
|
This setting determines whether this object will be visible or not |
|
Value of type ‘Boolean’ |
Yes |
|
This value determines the opacity of this renderable. A value of 0 means completely transparent |
|
In range: ( 0,1 ) |
Yes |
|
This value specifies if the renderable should be rendered in the Background,Opaque, Pre/PostDeferredTransparency, or Overlay rendering step |
|
In list { Background, Opaque, PreDeferredTransparent, PostDeferredTransparent, Overlay } |
Yes |
|
A single tag or a list of tags that this renderable will respond to when setting properties |
|
Value of type ‘Table’, or Value of type ‘String’ |
Yes |
|
This tells the type of the renderable |
|
Value of type ‘String’ |
Yes |
Table parameters for DataMapping
The mappings between data values and the variable names specified in the speck file
Optional: No
Name |
Documentation |
Type |
Description |
Optional |
---|---|---|---|---|
|
The name of the variable in the speck file that is used as the absolute magnitude variable |
|
Value of type ‘String’ |
Yes |
|
The name of the variable in the speck file that is used as the apparent magnitude variable |
|
Value of type ‘String’ |
Yes |
|
The name of the variable in the speck file that is used as the b-v color variable |
|
Value of type ‘String’ |
Yes |
|
The name of the variable in the speck file that is used as the luminance variable |
|
Value of type ‘String’ |
Yes |
|
The name of the variable in the speck file that is used as the speed |
|
Value of type ‘String’ |
Yes |
|
The name of the variable in the speck file that is used as the star velocity along the x-axis |
|
Value of type ‘String’ |
Yes |
|
The name of the variable in the speck file that is used as the star velocity along the y-axis |
|
Value of type ‘String’ |
Yes |
|
The name of the variable in the speck file that is used as the star velocity along the z-axis |
|
Value of type ‘String’ |
Yes |
Asset Examples
1local textures = asset.resource({
2 Name = "Stars Textures",
3 Type = "HttpSynchronization",
4 Identifier = "stars-denver_textures",
5 Version = 1
6})
7
8local speck = asset.resource({
9 Name = "Stars Speck Files",
10 Type = "HttpSynchronization",
11 Identifier = "stars-denver_speck",
12 Version = 1
13})
14
15local colorLUT = asset.resource({
16 Name = "Stars Color Table",
17 Type = "HttpSynchronization",
18 Identifier = "stars-denver_colormap",
19 Version = 2
20})
21
22
23local Object = {
24 Identifier = "Stars-Denver",
25 Renderable = {
26 Type = "RenderableStars",
27 File = speck .. "denver_stars.speck",
28 Halo = {
29 Texture = textures .. "halo.png"
30 },
31 ColorMap = colorLUT .. "denver_colorbv.cmap",
32 MagnitudeExponent = 6.2,
33 SizeComposition = "Distance Modulus",
34 DataMapping = {
35 Bv = "colorb_v",
36 Luminance = "lum",
37 AbsoluteMagnitude = "absmag",
38 ApparentMagnitude = "appmag",
39 Vx = "vx",
40 Vy = "vy",
41 Vz = "vz",
42 Speed = "speed"
43 }
44 },
45 GUI = {
46 Name = "Stars (Denver)",
47 Path = "/Milky Way/Stars"
48 }
49}
50
51
52asset.onInitialize(function()
53 openspace.addSceneGraphNode(Object)
54end)
55
56asset.onDeinitialize(function()
57 openspace.removeSceneGraphNode(Object)
58end)
59
60asset.export(Object)
61
62
63
64asset.meta = {
65 Name = "Stars Denver",
66 Version = "1.0",
67 Description = [[Alternative Milky Way Atlas: based on HIPPARCOS and Yale Bright
68 Star catalogs]],
69 Author = "Ka chun Yu",
70 URL = "http://openspaceproject.com",
71 License = "Creative Commons Attribution-Share Alike 3.0 Unported"
72}