SkyCube Class

A SkyBox drawn as a cube with an image mapped to each of its interior faces. Each member specifies the Id of a persistent texture element stored in the iModel from which the image mapped to the corresponding face is obtained.

see SkyBox.createFromJSON.

Extends

Implements

Methods

Name Description
constructor(sky?: SkyBoxProps): SkyCube Protected    
toJSON(): SkyBoxProps    
create(front: Id64String, back: Id64String, top: Id64String, bottom: Id64String, right: Id64String, left: Id64String, display?: false | true): SkyCube | undefined Static Create and return a SkyCube.  

Inherited methods

Name Inherited from Description
createFromJSON(json?: SkyBoxProps): SkyBox Static SkyBox Instantiate a SkyBox from its JSON representation.

Properties

Name Type Description
back Id64String Id of a persistent texture element stored in the iModel to use for the back side of the skybox cube.  
bottom Id64String Id of a persistent texture element stored in the iModel to use for the bottom of the skybox cube.  
front Id64String Id of a persistent texture element stored in the iModel to use for the front side of the skybox cube.  
left Id64String Id of a persistent texture element stored in the iModel to use for the left side of the skybox cube.  
right Id64String Id of a persistent texture element stored in the iModel to use for the front right of the skybox cube.  
top Id64String Id of a persistent texture element stored in the iModel to use for the top of the skybox cube.  

Inherited properties

Name Type Inherited from Description
display boolean SkyBox Whether or not the skybox should be displayed.

Defined in

Last Updated: 20 September, 2019