Gorilla.SkyBox

The component DO NOT use CubeMap technology yet. This is a feature for future releases and should remove tiny border spaces during rendering. At the moment 6 planes are generated and rendered with a single texture for each side.

Ancestors

-TGorillaCube

-TGorillaMesh

-TGorillaTransform

-TGorillaControl

-TControl3D

-TFmxObject

-TComponent

-TPersistent

-TObject

Members

Fields

protected FSubdivisionsAxes : Integer
protected FSubdivisionsHeight : Integer
protected FDoUpdateCubeMap : Boolean
protected FTextures :
protected FMaterial : TGorillaSkyBoxMaterialSource

Methods

public constructor Create ( AOwner : TComponent ) ;
public destructor Destroy ( ) ;
protected function GetMode ( ) : TGorillaSkyBoxMode ;
protected procedure SetMode ( const AValue : TGorillaSkyBoxMode ) ;
protected function GetSize ( ) : TPoint3D ;
protected procedure SetSize ( const AValue : TPoint3D ) ;
protected function GetTexture ( AIndex : TGorillaCubeMapFace ) : TBitmap ;
protected procedure SetTexture ( AIndex : TGorillaCubeMapFace; const AValue : TBitmap ) ;
protected function GetAllowFog ( ) : Boolean ;
protected procedure SetAllowFog ( AValue : Boolean ) ;
protected procedure DoCubeMapChanged ( Sender : TObject ) ;
protected procedure CreateTextures ( ) ; virtual;
protected procedure DestroyTextures ( ) ; virtual;
protected procedure DoUpdateCubeMap ( ) ; virtual;
protected procedure DoRebuildSphereMesh ( AIsStatic : Boolean = True ) ;
protected procedure Render ( ) ; override;
Override the internal render method to initialize planes and materials.
protected function GetAzimuth ( ) : Single ;
protected function GetCloudAmplitude ( ) : Single ;
protected function GetCloudColor ( ) : TAlphaColor ;
protected function GetCloudFrequency ( ) : Single ;
protected function GetCloudIterations ( ) : Integer ;
protected function GetCrescentMoon ( ) : Single ;
protected function GetCrescent ( ) : Boolean ;
protected function GetCrescentOfs ( ) : TPointF ;
protected function GetCrescentOfsX ( ) : Single ;
protected function GetCrescentOfsY ( ) : Single ;
protected function GetDepolarizationFactor ( ) : Single ;
protected function GetDiffuse ( ) : TAlphaColor ;
protected function GetEmissive ( ) : TAlphaColor ;
protected function GetInclination ( ) : Single ;
protected function GetLuminance ( ) : Single ;
protected function GetMieCoefficient ( ) : Single ;
protected function GetMieDirectionalG ( ) : Single ;
protected function GetMieKCoefficient ( ) : TVector3D ;
protected function GetMieKCoefficientByIdx ( AIndex : Integer ) : Single ;
protected function GetMieV ( ) : Single ;
protected function GetMieZenithLength ( ) : Single ;
protected function GetMoonSurface ( ) : Single ;
protected function GetNumMolecules ( ) : Single ;
protected function GetPrimaries ( ) : TPoint3D ;
protected function GetPrimariesByIdx ( AIndex : Integer ) : Single ;
protected function GetRayleigh ( ) : Single ;
protected function GetRayleighZenithLength ( ) : Single ;
protected function GetRefractiveIndex ( ) : Single ;
protected function GetStarBrightness ( ) : Single ;
protected function GetStarColor ( ) : TAlphaColor ;
protected function GetStarDensity ( ) : Single ;
protected function GetStarProbe ( ) : Single ;
protected function GetStarSize ( ) : Single ;
protected function GetStarSpark ( ) : Single ;
protected function GetSunAngularDiameterDegrees ( ) : Single ;
protected function GetSunIntensityFactor ( ) : Single ;
protected function GetSunIntensityFalloffSteepness ( ) : Single ;
protected function GetTonemapWeighting ( ) : Single ;
protected function GetTurbidity ( ) : Single ;
protected procedure SetAzimuth ( const AValue : Single ) ;
protected procedure SetCloudAmplitude ( const AValue : Single ) ;
protected procedure SetCloudColor ( const AValue : TAlphaColor ) ;
protected procedure SetCloudFrequency ( const AValue : Single ) ;
protected procedure SetCloudIterations ( const AValue : Integer ) ;
protected procedure SetCrescentMoon ( const AValue : Single ) ;
protected procedure SetCrescent ( const AValue : Boolean ) ;
protected procedure SetCrescentOfs ( const AValue : TPointF ) ;
protected procedure SetCrescentOfsX ( const AValue : Single ) ;
protected procedure SetCrescentOfsY ( const AValue : Single ) ;
protected procedure SetDepolarizationFactor ( const AValue : Single ) ;
protected procedure SetDiffuse ( const AValue : TAlphaColor ) ;
protected procedure SetEmissive ( const AValue : TAlphaColor ) ;
protected procedure SetInclination ( const AValue : Single ) ;
protected procedure SetLuminance ( const AValue : Single ) ;
protected procedure SetMieCoefficient ( const AValue : Single ) ;
protected procedure SetMieDirectionalG ( const AValue : Single ) ;
protected procedure SetMieKCoefficient ( const AValue : TVector3D ) ;
protected procedure SetMieKCoefficientByIdx ( AIndex : Integer; const AValue : Single ) ;
protected procedure SetMieV ( const AValue : Single ) ;
protected procedure SetMieZenithLength ( const AValue : Single ) ;
protected procedure SetMoonSurface ( const AValue : Single ) ;
protected procedure SetNumMolecules ( const AValue : Single ) ;
protected procedure SetPrimaries ( const AValue : TPoint3D ) ;
protected procedure SetPrimariesByIdx ( AIndex : Integer; const AValue : Single ) ;
protected procedure SetRayleigh ( const AValue : Single ) ;
protected procedure SetRayleighZenithLength ( const AValue : Single ) ;
protected procedure SetRefractiveIndex ( const AValue : Single ) ;
protected procedure SetStarBrightness ( const AValue : Single ) ;
protected procedure SetStarColor ( const AValue : TAlphaColor ) ;
protected procedure SetStarDensity ( const AValue : Single ) ;
protected procedure SetStarProbe ( const AValue : Single ) ;
protected procedure SetStarSize ( const AValue : Single ) ;
protected procedure SetStarSpark ( const AValue : Single ) ;
protected procedure SetSunAngularDiameterDegrees ( const AValue : Single ) ;
protected procedure SetSunIntensityFactor ( const AValue : Single ) ;
protected procedure SetSunIntensityFalloffSteepness ( const AValue : Single ) ;
protected procedure SetTonemapWeighting ( const AValue : Single ) ;
protected procedure SetTurbidity ( const AValue : Single ) ;
public procedure LoadCubeMapFacesFromPath ( APath : string; AFileExt : string ) ;
Automatically load a cubemap defined by its path to the texture sides of the skybox.
public procedure RebuildMesh ( AIsStatic : Boolean = True ) ; override;
public function GetConfiguration ( ) : TSkyBoxShaderData ;
Get all skybox settings (except textures) at once.
public procedure SetConfiguration ( const AProps : TSkyBoxShaderData ) ;
To set all configuration properties at once.
public function ToJSON ( ) : TJSONObject ;
To save skybox settings into a json format. Except textures all properties will be stored.
public procedure FromJSON ( AJSON : TJSONObject ) ;
To load skybox settings from a json object. Except textures all properties are loaded.
public procedure LoadFromStream ( AStream : TStream ) ;
Load skybox configuration (without textures) from stream in JSON format.
public procedure LoadFromFile ( AFileName : string ) ;
Load skybox configuration (without textures) from file in JSON format.
public procedure SaveToStream ( AStream : TStream ) ;
Save skybox configuration (without textures) to stream in JSON format.
public procedure SaveToFile ( AFileName : string ) ;
Save skybox configuration (without textures) to file in JSON format.

Properties

public Size : TPoint3D
Defines the size of the skybox. The property handles the width, height and depth property of the default TControl3D component class by a Point3D.
read GetSize
write SetSize
public Textures[Index] : TBitmap
Indiced texture array property for applying a texture to a single side of the skybox.
read GetTexture
write SetTexture
public CrescentOfs : TPointF
Get or set the X and Y offset of the shadow of a crescendent sundisk/moon.
read GetCrescentOfs
write SetCrescentOfs
public MieKCoefficient : TVector3D
read GetMieKCoefficient
write SetMieKCoefficient
public Primaries : TPoint3D
Primaries control the basis coloring of sun gradient computation. It's recommended to use very low values < 0e-6.
read GetPrimaries
write SetPrimaries
published Mode : TGorillaSkyBoxMode
Get or set the current skybox rendering mode. The skybox component supports a simple and fast cubemap rendering with textures and different procedural skybox types.
read GetMode
write SetMode
published AllowFog : Boolean
Allow or disable fog computation for the skybox itself.
read GetAllowFog
write SetAllowFog
published FrontSide : TBitmap
Get or set the front side image of the skybox. Alternatively set bitmap by Textures[TGorillaCubeMapFace.NegativeZ].
read GetTexture
write SetTexture
published BackSide : TBitmap
Get or set the back side image of the skybox. Alternatively set bitmap by Textures[TGorillaCubeMapFace.PositiveZ].
read GetTexture
write SetTexture
published TopSide : TBitmap
Get or set the top side image of the skybox. Alternatively set bitmap by Textures[TGorillaCubeMapFace.PositiveY].
read GetTexture
write SetTexture
published BottomSide : TBitmap
Get or set the bottom side image of the skybox. Alternatively set bitmap by Textures[TGorillaCubeMapFace.NegativeY].
read GetTexture
write SetTexture
published LeftSide : TBitmap
Get or set the left side image of the skybox. Alternatively set bitmap by Textures[TGorillaCubeMapFace.NegativeX].
read GetTexture
write SetTexture
published RightSide : TBitmap
Get or set the right side image of the skybox. Alternatively set bitmap by Textures[TGorillaCubeMapFace.PositiveX].
read GetTexture
write SetTexture
published CrescentMoon : Single
Get or set the brightness of a sundisk/moon shadow. If the value is zero no shadow will be rendered.
read GetCrescentMoon
write SetCrescentMoon
published Crescent : Boolean
Activate/Deactivate the crescent moon.
read GetCrescent
write SetCrescent
published CrescentOfsX : Single
Get or set the X offset of the shadow of a crescendent sundisk/moon.
read GetCrescentOfsX
write SetCrescentOfsX
published CrescentOfsY : Single
Get or set the Y offset of the shadow of a crescendent sundisk/moon.
read GetCrescentOfsY
write SetCrescentOfsY
published MoonSurface : Single
Get or set intensity of a rendered moon surface. If the value is zero, no surface will be rendered.
read GetMoonSurface
write SetMoonSurface
published DepolarizationFactor : Single
read GetDepolarizationFactor
write SetDepolarizationFactor
published Diffuse : TAlphaColor
Get or set diffuse color. On blank rendering this represents the blank color, while other modes will be colorized.
read GetDiffuse
write SetDiffuse
published Emissive : TAlphaColor
Get or set emissive color. On blank rendering emissive color is ignored.
read GetEmissive
write SetEmissive
published Luminance : Single
read GetLuminance
write SetLuminance
published MieCoefficient : Single
read GetMieCoefficient
write SetMieCoefficient
published MieDirectionalG : Single
read GetMieDirectionalG
write SetMieDirectionalG
published MieV : Single
read GetMieV
write SetMieV
published MieZenithLength : Single
read GetMieZenithLength
write SetMieZenithLength
published MieKCoefficientX : Single
read GetMieKCoefficientByIdx
write SetMieKCoefficientByIdx
published MieKCoefficientY : Single
read GetMieKCoefficientByIdx
write SetMieKCoefficientByIdx
published MieKCoefficientZ : Single
read GetMieKCoefficientByIdx
write SetMieKCoefficientByIdx
published MieKCoefficientW : Single
read GetMieKCoefficientByIdx
write SetMieKCoefficientByIdx
published PrimariesA : Single
Primaries control the basis coloring of sun gradient computation. It's recommended to use very low values < 0e-6.
read GetPrimariesByIdx
write SetPrimariesByIdx
published PrimariesB : Single
Primaries control the basis coloring of sun gradient computation. It's recommended to use very low values < 0e-6.
read GetPrimariesByIdx
write SetPrimariesByIdx
published PrimariesC : Single
Primaries control the basis coloring of sun gradient computation. It's recommended to use very low values < 0e-6.
read GetPrimariesByIdx
write SetPrimariesByIdx
published NumMolecules : Single
Get or set the number of molecules. This is a very large number, f.e. 4e25. The larger the number is, the more noisy the result will become.
read GetNumMolecules
write SetNumMolecules
published Rayleigh : Single
read GetRayleigh
write SetRayleigh
published RayleighZenithLength : Single
read GetRayleighZenithLength
write SetRayleighZenithLength
published RefractiveIndex : Single
read GetRefractiveIndex
write SetRefractiveIndex
published SunAngularDiameterDegrees : Single
Get or set the diameter of sundisk/moon. In fact this controls the size of your rendered sun/moon.
read GetSunAngularDiameterDegrees
write SetSunAngularDiameterDegrees
published SunIntensityFactor : Single
read GetSunIntensityFactor
write SetSunIntensityFactor
published SunIntensityFalloffSteepness : Single
read GetSunIntensityFalloffSteepness
write SetSunIntensityFalloffSteepness
published TonemapWeighting : Single
read GetTonemapWeighting
write SetTonemapWeighting
published Turbidity : Single
read GetTurbidity
write SetTurbidity
published Inclination : Single
Get or set inclination of the sundisk/moon. In combination with the Azimuth property this will control the position of the sundisk/moon on the skybox.
read GetInclination
write SetInclination
published Azimuth : Single
Get or set the azimuth of the sundisk/moon. In combination with the Inclination property this will control the position of the sundisk/moon on the skybox.
read GetAzimuth
write SetAzimuth
published StarDensity : Single
Get or set the density of stars rendered. If the value is zero, no stars will be rendered.
read GetStarDensity
write SetStarDensity
published StarProbe : Single
Get or set the randomness limit value of rendered stars. This value influences the number of and distribution of stars.
read GetStarProbe
write SetStarProbe
published StarSize : Single
Get or set the size of rendered bright stars.
read GetStarSize
write SetStarSize
published StarSpark : Single
Get or set the size/length of star sparks rendered.
read GetStarSpark
write SetStarSpark
published StarBrightness : Single
Get or set the brightness of rendered stars.
read GetStarBrightness
write SetStarBrightness
published StarColor : TAlphaColor
Get or set the color of rendered stars.
read GetStarColor
write SetStarColor
published CloudColor : TAlphaColor
Get or set the color of rendered clouds.
read GetCloudColor
write SetCloudColor
published CloudIterations : Integer
Get or set the number of iterations performed to produce clouds in the shader. The more iterations, the more noise will be rendered.
read GetCloudIterations
write SetCloudIterations
published CloudFrequency : Single
Get or set the frequency used to render clouds. The frequency controls also the size of clouds. The lower the value is, the larger the clouds. Combine this property with CloudIterations to produce a good result.
read GetCloudFrequency
write SetCloudFrequency
published CloudAmplitude : Single
Get or set the amplitude of rendered clouds. The amplitude controls the mixture of bright and dark parts of a cloud. The larger the value is, the more extreme the change between bright and dark will become.
read GetCloudAmplitude
write SetCloudAmplitude