Tutorial_30_SceneViewWidget

Description

abstract class Tinman.Demo.Tutorials._3_Scene.Tutorial_30_SceneViewWidget

Derived from

Tutorial_03_Widget<SceneViewWidget> abstract
IEventListenerGeneric<Component>

Extended by

Tutorial_31_Showcase sealed
Tutorial_32_Gallery sealed
Tutorial_33_Effects sealed
Tutorial_34_Water sealed
Tutorial_35_Physics sealed
Tutorial_36_ImportExport sealed
Tutorial_38_Performance sealed
Tutorial_39_Editor sealed

Full source code is included in the Tinman 3D SDK download.

Tinman 3D tutorial #30 : SceneViewWidget

This is the base class for tutorials that demonstrate how to use the Scene API. In this class, you will find some commonly used factory methods for creating scene components.

Public / Constants

Texture​Atlas​Id_​RGB_​Compressed

public constant TextureAtlasId_RGB_Compressed → ("RGB_Compressed":string)

Texture atlas for compressed RGB pixel data.

See also

TextureFormat.BC1

Texture​Atlas​Id_​RGBA_​Compressed

public constant TextureAtlasId_RGBA_Compressed → ("RGBA_Compressed":string)

Texture atlas for compressed RGBA pixel data.

See also

TextureFormat.A4B4G4R4

Texture​Atlas​Id_​RGBA_​Uncompressed

public constant TextureAtlasId_RGBA_Uncompressed → ("RGBA_Uncompressed":string)

Texture atlas for uncompressed RGBA pixel data.

See also

TextureFormat.A8R8G8B8

Public / Methods

Create​Default​Texture​Layer

public static method CreateDefaultTextureLayer → (1)

options in : SceneOptions

[not-null]
The scene options object.

Declares the texture caches for the default texture layer by calling SceneOptions.TextureAtlas.

See also

Tutorial_30_SceneViewWidget.CreateDefaultTextureLayer

public method CreateDefaultTextureLayer → ()

Creates the default texture layer and adds it to the scene.

The default texture layer is a TextureLayer scene entity that uses three pixel pyramids as content: a low-resolution albedo map for imagery (BlueMarble2), a linear normal map based on elevation and a linear reflectivity/gloss map for water bodies.

IOException

If an I/O error has occurred.

Create​Heightmap_​Earth_​DEM

[OwnerReturn]
public static method CreateHeightmap_Earth_DEM → (2)

path in : Path

The path to the Earth datasets (https://data.tinman3d.online/?dir=geo/Earth).

provider opt : IHeightmapProvider = null

The heightmap provider to use or null to open heightmaps directly via HeightmapCollection.

returns → IHeightmap

The Moon heightmap.

Creates a heightmap for the DEM of the Earth.

IOException

If an I/O error has occurred.

Create​Heightmap_​Earth_​Geoid

[OwnerReturn]
public static method CreateHeightmap_Earth_Geoid → (2)

path in : Path

The path to the Earth datasets (https://data.tinman3d.online/?dir=geo/Earth).

provider opt : IHeightmapProvider = null

The heightmap provider to use or null to open heightmaps directly via HeightmapCollection.

returns → IHeightmap

The Moon heightmap.

Creates a heightmap for the geoid of the Earth.

IOException

If an I/O error has occurred.

Create​Heightmap_​Moon_​DEM

[OwnerReturn]
public static method CreateHeightmap_Moon_DEM → (2)

path in : Path

The path to the Moon datasets (https://data.tinman3d.online/?dir=geo/Moon/LROC).

provider opt : IHeightmapProvider = null

The heightmap provider to use or null to open heightmaps directly via HeightmapCollection.

returns → IHeightmap

The Moon heightmap.

Creates a heightmap for the Moon.

IOException

If an I/O error has occurred.

Create​Scene​And​Primary​View

[ThrowAny]
public static method CreateSceneAndPrimaryView → (3)

widget in : SceneViewWidget

[not-null]
The widget to use.

options in : SceneOptions own

[not-null]
The scene options.

entityViewMask opt : int64 = ~0

The entity mask of the primary view, see IEntityViewMask.EntityViewMask.

returns → Scene

The created Scene object.

Creates a new Scene object using the given options in, along with a primary ISceneView3D.

Create​Scene​Options

[OwnerReturn]
public static method CreateSceneOptions → (1)

path in : Path

[not-null]
Path to the directory where to store the file caches.

returns → SceneOptions

The SceneOptions object.

Creates a SceneOptions objects for building a new IScene instance.

Load​Flight​Path

public method LoadFlightPath → (2)

name in : string

[not-null]
File name of the *.csv flight path file in the Engine:/Data/3drParty/ directory.

pitchOffset in : float64

The pitch offset to use. A pitch offset is required if the recording device was mounted at an inclined angle in the aircraft.

returns → IGeoPathBase

The loaded flight path.

Loads a flight path.

IOException

If an I/O error has occurred.

Render​Please​Wait

public static method RenderPleaseWait → (3)

graphics in : Graphics

The Graphics object to use.

bounds in : Box2I

The screen bounds in graphics in.

ready in : float64

The amount of readiness, in percent.

This method can be used as a PleaseWaitDelegate for rendering a please-wait prompt while the scene is loading.