Project

General

Profile

SO3Engine
Water/Sky management

Functions

int SO3EnvironmentRegisterViewport (mmachine m)
 main include More...
 
int SO3EnvironmentUnregisterViewport (mmachine m)
 SO3EnvironmentUnregisterViewport : More...
 
int SO3EnvironmentGetRegisteredViewports (mmachine m)
 SO3EnvironmentGetRegisteredViewports : More...
 
int SO3EnvironmentGetEnable (mmachine m)
 SO3EnvironmentGetEnable : More...
 
int SO3EnvironmentSetEnable (mmachine m)
 SO3EnvironmentSetEnable : More...
 
int SO3EnvironmentGetWindSpeed (mmachine m)
 SO3EnvironmentGetWindSpeed : More...
 
int SO3EnvironmentSetWindSpeed (mmachine m)
 SO3EnvironmentSetWindSpeed : More...
 
int SO3EnvironmentGetWindDirection (mmachine m)
 SO3EnvironmentGetWindDirection : More...
 
int SO3EnvironmentSetWindDirection (mmachine m)
 SO3EnvironmentSetWindDirection : More...
 
int SO3EnvironmentGetHumidity (mmachine m)
 SO3EnvironmentGetHumidity : More...
 
int SO3EnvironmentSetHumidity (mmachine m)
 SO3EnvironmentSetHumidity : More...
 
int SO3EnvironmentGetTimeSpeedFactor (mmachine m)
 SO3EnvironmentGetTimeSpeedFactor : More...
 
int SO3EnvironmentSetTimeSpeedFactor (mmachine m)
 SO3EnvironmentSetTimeSpeedFactor : More...
 
int SO3EnvironmentGetPaused (mmachine m)
 SO3EnvironmentGetPaused : More...
 
int SO3EnvironmentSetPaused (mmachine m)
 SO3EnvironmentSetPaused : More...
 
int SO3EnvironmentGetDateTime (mmachine m)
 SO3EnvironmentGetDateTime : More...
 
int SO3EnvironmentSetDateTime (mmachine m)
 SO3EnvironmentSetDateTime : More...
 
int SO3EnvironmentGetLongitude (mmachine m)
 SO3EnvironmentGetLongitude : More...
 
int SO3EnvironmentSetLongitude (mmachine m)
 SO3EnvironmentSetLongitude : More...
 
int SO3EnvironmentGetLatitude (mmachine m)
 SO3EnvironmentGetLatitude : More...
 
int SO3EnvironmentSetLatitude (mmachine m)
 SO3EnvironmentSetLatitude : More...
 
int SO3WaterGetEnable (mmachine m)
 SO3WaterGetEnable : More...
 
int SO3WaterSetEnable (mmachine m)
 SO3WaterSetEnable : More...
 
int SO3WaterComponentGetEnabled (mmachine m)
 SO3WaterComponentGetEnabled : More...
 
int SO3WaterComponentSetEnabled (mmachine m)
 SO3WaterComponentSetEnabled : More...
 
int SO3SkyGetEnable (mmachine m)
 SO3SkyGetEnable : More...
 
int SO3SkySetEnable (mmachine m)
 SO3SkySetEnable : More...
 
int SO3SkyComponentGetEnabled (mmachine m)
 SO3SkyComponentGetEnabled : More...
 
int SO3SkyComponentSetEnabled (mmachine m)
 SO3SkyComponentSetEnabled : More...
 
int SO3WaterGetPosition (mmachine m)
 SO3WaterGetPosition : More...
 
int SO3WaterSetPosition (mmachine m)
 SO3WaterSetPosition : More...
 
int SO3WaterGetColor (mmachine m)
 SO3WaterGetColor : More...
 
int SO3WaterSetColor (mmachine m)
 SO3WaterSetColor : More...
 
int SO3WaterGetAnimationSpeed (mmachine m)
 SO3WaterGetAnimationSpeed : More...
 
int SO3WaterSetAnimationSpeed (mmachine m)
 SO3WaterSetAnimationSpeed : More...
 
int SO3WaterGetSunParameters (mmachine m)
 SO3WaterGetSunParameters : More...
 
int SO3WaterSetSunParameters (mmachine m)
 SO3WaterSetSunParameters : More...
 
int SO3WaterGetFoamParameters (mmachine m)
 SO3WaterGetFoamParameters : More...
 
int SO3WaterSetFoamParameters (mmachine m)
 SO3WaterSetFoamParameters : More...
 
int SO3WaterGetDepthParameters (mmachine m)
 SO3WaterGetDepthParameters : More...
 
int SO3WaterSetDepthParameters (mmachine m)
 SO3WaterSetDepthParameters : More...
 
int SO3WaterGetSmoothPower (mmachine m)
 SO3WaterGetSmoothPower : More...
 
int SO3WaterSetSmoothPower (mmachine m)
 SO3WaterSetSmoothPower : More...
 
int SO3WaterGetCausticsParameters (mmachine m)
 SO3WaterGetCausticsParameters : More...
 
int SO3WaterSetCausticsParameters (mmachine m)
 SO3WaterSetCausticsParameters : More...
 
int SO3WaterGetGodRaysParameters (mmachine m)
 SO3WaterGetGodRaysParameters : More...
 
int SO3WaterSetGodRaysParameters (mmachine m)
 SO3WaterSetGodRaysParameters : More...
 
int SO3WaterGetPerlinNoiseParameters (mmachine m)
 SO3WaterGetPerlinNoiseParameters : More...
 
int SO3WaterSetPerlinNoiseParameters (mmachine m)
 SO3WaterSetPerlinNoiseParameters : More...
 
int SO3WaterGetFftNoiseParameters (mmachine m)
 SO3WaterGetFftNoiseParameters : More...
 
int SO3WaterSetFftNoiseParameters (mmachine m)
 SO3WaterSetFftNoiseParameters : More...
 
int SO3WaterGetWaveParameters (mmachine m)
 SO3WaterGetWaveParameters : Get the water mesh parameters. More...
 
int SO3WaterSetWaveParameters (mmachine m)
 SO3WaterSetWaveParameters : Set the water mesh parameters. More...
 
int SO3WaterGetGeometryComplexity (mmachine m)
 SO3WaterGetGeometryComplexity : Set the water mesh complexity. More...
 
int SO3WaterSetGeometryComplexity (mmachine m)
 SO3WaterSetGeometryComplexity : Set the water mesh complexity. More...
 
int SO3SkyGetAnimationSpeed (mmachine m)
 SO3SkyGetAnimationSpeed : More...
 
int SO3SkySetAnimationSpeed (mmachine m)
 SO3SkySetAnimationSpeed : More...
 
int SO3SkyGetHdrEnable (mmachine m)
 SO3SkyGetHdrEnable : More...
 
int SO3SkySetHdrEnable (mmachine m)
 SO3SkySetHdrEnable : More...
 
int SO3SkyGetCloudCeiling (mmachine m)
 SO3SkyGetCloudCeiling : More...
 
int SO3SkySetCloudCeiling (mmachine m)
 SO3SkySetCloudCeiling : More...
 
int SO3SkyAddLayeredCloud (mmachine m)
 SO3SkyAddLayeredCloud : More...
 
int SO3SkyRemoveLayeredCloud (mmachine m)
 SO3SkyAddLayeredCloud : More...
 
int SO3SkyGetLayeredCloudIndexes (mmachine m)
 SO3SkyGetLayeredCloudIndexes : More...
 
int SO3SkyGetLayeredCloudParameters (mmachine m)
 SO3SkyGetLayeredCloudParameters : More...
 
int SO3SkySetLayeredCloudParameters (mmachine m)
 SO3SkySetLayeredCloudParameters : More...
 
int SO3SkySetLightningEnable (mmachine m)
 SO3SkySetLightningEnable : Set the sky Lightning state, the sky component must be set on SO3_SKY_COMPONENT_VOLUMETRIC_CLOUD. More...
 
int SO3SkyAddLightning (mmachine m)
 SO3SkyAddLightning : Set the sky Lightning state, the sky component must be set on SO3_SKY_COMPONENT_VOLUMETRIC_CLOUD. More...
 
int SO3SkyGetVolumetricCloudParameters (mmachine m)
 SO3SkyGetVolumetricCloudParameters : More...
 
int SO3SunGetLightColor (mmachine m)
 SO3SunGetLightColor : More...
 
int SO3SunSetLightColor (mmachine m)
 SO3SunSetLightColor : More...
 
int SO3MoonGetLightColor (mmachine m)
 SO3MoonGetLightColor : More...
 
int SO3MoonSetLightColor (mmachine m)
 SO3MoonSetLightColor : More...
 
int SO3MoonGetTexturePath (mmachine m)
 SO3MoonGetLightColor : More...
 
int SO3MoonSetTexturePath (mmachine m)
 SO3MoonSetTexturePath : More...
 

Detailed Description

Scol functions definition

Function Documentation

◆ SO3EnvironmentGetDateTime()

int SO3EnvironmentGetDateTime ( mmachine  m)

SO3EnvironmentGetDateTime :

Prototype: fun [SO3_SCENE] [I I I I I I]

Parameters
SO3_SCENE: The scene on which we want to know the environment date/time
Returns
[I I I I I I] : Current date/time.
  • I : year
  • I : month
  • I : day
  • I : hours
  • I : minutes
  • I : seconds

Definition at line 783 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentGetEnable()

int SO3EnvironmentGetEnable ( mmachine  m)

SO3EnvironmentGetEnable :

Prototype:fun [SO3_SCENE] I

Parameters
SO3_SCENE: The scene to which the environment belongs
Returns
I : True is the environment rendering is actually enabled, false otherwise.

Definition at line 252 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentGetHumidity()

int SO3EnvironmentGetHumidity ( mmachine  m)

SO3EnvironmentGetHumidity :

Prototype: fun [SO3_SCENE] F

Parameters
SO3_SCENE: The scene on which we want to know the global humidity factor in percent.
Returns
F : The humidity factor

Definition at line 517 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentGetLatitude()

int SO3EnvironmentGetLatitude ( mmachine  m)

SO3EnvironmentGetLatitude :

Prototype: fun [SO3_SCENE] F

Parameters
SO3_SCENE: The scene on which we want to know the observer latitude
Returns
F : The observer latitude, in degrees. Positive values are for Northern latitudes, negative values for Southern, 0 is equator.

Definition at line 996 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentGetLongitude()

int SO3EnvironmentGetLongitude ( mmachine  m)

SO3EnvironmentGetLongitude :

Prototype: fun [SO3_SCENE] F

Parameters
SO3_SCENE: The scene on which we want to know the observer longitude
Returns
F : The observer longitude, in degrees. Positive values are for Eastern longitudes, negative values for Western, 0 is Prime meridian (or "Greenwich" meridian).

Definition at line 915 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentGetPaused()

int SO3EnvironmentGetPaused ( mmachine  m)

SO3EnvironmentGetPaused :

Prototype:fun [SO3_SCENE] I

Parameters
SO3_SCENE: The scene to which the environment belongs
Returns
I : True is the environment is actually paused (no sun/moon position update, nor waves/clouds animations), false otherwise.

Definition at line 686 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentGetRegisteredViewports()

int SO3EnvironmentGetRegisteredViewports ( mmachine  m)

SO3EnvironmentGetRegisteredViewports :

Prototype: fun [SO3_SCENE] [SO3_VIEWPORT r1]

Parameters
SO3_SCENE: The scene on which we want to deactivate the environment rendering
Returns
[SO3_VIEWPORT r1] : The list of activated viewports, NIL otherwise

Definition at line 172 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentGetTimeSpeedFactor()

int SO3EnvironmentGetTimeSpeedFactor ( mmachine  m)

SO3EnvironmentGetTimeSpeedFactor :

Prototype: fun [SO3_SCENE] F

Parameters
SO3_SCENE: The scene on which we want to know the time speed factor.
Returns
F : The time speed factor, ie how many seconds are elapsed for a "real" second.
For example, a factor of 1 will advance the environment simulation at real time. Use a factor of 0 to pause the environment simulation. A factor of 60 will advance the simulation 1 minute every second, and a factor of 3600 will advance the simulation 1 hour every second.

Definition at line 599 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentGetWindDirection()

int SO3EnvironmentGetWindDirection ( mmachine  m)

SO3EnvironmentGetWindDirection :

Prototype: fun [SO3_SCENE] [F F]

Parameters
SO3_SCENE: The scene on which we want to know the wind direction.
Returns
[F F] : The wind direction, as a 2d vector.
  • F : x vector value
  • F : y vector value

Definition at line 425 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentGetWindSpeed()

int SO3EnvironmentGetWindSpeed ( mmachine  m)

SO3EnvironmentGetWindSpeed :

Prototype: fun [SO3_SCENE] F

Parameters
SO3_SCENE: The scene on which we want to know the wind speed.
Returns
F : The wind speed.

Definition at line 342 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentRegisterViewport()

int SO3EnvironmentRegisterViewport ( mmachine  m)

main include

SO3EnvironmentRegisterViewport :

Prototype: fun [SO3_SCENE SO3_VIEWPORT] I

Parameters
SO3_SCENE: The scene on which we want to activate the environment rendering
SO3_VIEWPORT: The viewport that will be used to render the scene (needed for compositors and cameras tracking).
Returns
I : 1 if success , NIL otherwise

Definition at line 57 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentSetDateTime()

int SO3EnvironmentSetDateTime ( mmachine  m)

SO3EnvironmentSetDateTime :

Prototype: fun [SO3_SCENE I I I I I I] I

Parameters
SO3_SCENE: The scene on which we want to set the environment date/time
I: year (NIL to keep existing value)
I: month (NIL to keep existing value)
I: day (NIL to keep existing value)
I: hours (NIL to keep existing value)
I: minutes (NIL to keep existing value)
I: seconds (NIL to keep existing value)
Returns
I : 1 if success, NIL otherwise.

Definition at line 841 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentSetEnable()

int SO3EnvironmentSetEnable ( mmachine  m)

SO3EnvironmentSetEnable :

Prototype:fun [SO3_SCENE I] I

Parameters
SO3_SCENE: The scene to which the environment belongs
I: Set to "true" to enable the environment rendering, false to deactivate it.
Returns
I : 1 if success, NIL otherwise.

Definition at line 297 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentSetHumidity()

int SO3EnvironmentSetHumidity ( mmachine  m)

SO3EnvironmentSetHumidity :

Prototype: fun [SO3_SCENE F] I

Parameters
SO3_SCENE: The scene on which we want to set the global humidity factor in percent
F: humidity factor
Returns
I : 1 if success, NIL otherwise.

Definition at line 558 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentSetLatitude()

int SO3EnvironmentSetLatitude ( mmachine  m)

SO3EnvironmentSetLatitude :

Prototype: fun [SO3_SCENE F] I

Parameters
SO3_SCENE: The scene on which we want to set the observer latitude
F: The observer latitude, in degrees. Positive values are for Northern latitudes, negative values for Southern, 0 is equator.
Returns
I : 1 if success, NIL otherwise.

Definition at line 1036 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentSetLongitude()

int SO3EnvironmentSetLongitude ( mmachine  m)

SO3EnvironmentSetLongitude :

Prototype: fun [SO3_SCENE F] I

Parameters
SO3_SCENE: The scene on which we want to set the observer longitude
F: The observer longitude, in degrees. Positive values are for Eastern longitudes, negative values for Western, 0 is Prime meridian (or "Greenwich" meridian).
Returns
I : 1 if success, NIL otherwise.

Definition at line 955 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentSetPaused()

int SO3EnvironmentSetPaused ( mmachine  m)

SO3EnvironmentSetPaused :

Prototype:fun [SO3_SCENE I] I

Parameters
SO3_SCENE: The scene to which the environment belongs
I: Set to "true" to pause the environment (no sun/moon position update, nor waves/clouds animations), false to resume.
Returns
I : 1 if success, NIL otherwise.

Definition at line 731 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentSetTimeSpeedFactor()

int SO3EnvironmentSetTimeSpeedFactor ( mmachine  m)

SO3EnvironmentSetTimeSpeedFactor :

Prototype: fun [SO3_SCENE F] I

Parameters
SO3_SCENE: The scene on which we want to set the time speed factor.
F: The time speed factor, ie how many seconds are elapsed for a "real" second.
For example, a factor of 1 will advance the environment simulation at real time. Use a factor of 0 (or NIL) to pause the environment simulation. A factor of 60 will advance the simulation 1 minute every second, and a factor of 3600 will advance the simulation 1 hour every second.
Returns
I : 1 if success, NIL otherwise.

Definition at line 639 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentSetWindDirection()

int SO3EnvironmentSetWindDirection ( mmachine  m)

SO3EnvironmentSetWindDirection :

Prototype: fun [SO3_SCENE F F] I

Parameters
SO3_SCENE: The scene on which we want to set the wind direction.
F: x value of the wind direction vector
F: y value of the wind direction vector
Returns
I : 1 if success, NIL otherwise.

Definition at line 475 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentSetWindSpeed()

int SO3EnvironmentSetWindSpeed ( mmachine  m)

SO3EnvironmentSetWindSpeed :

Prototype: fun [SO3_SCENE F] I

Parameters
SO3_SCENE: The scene on which we want to set the wind speed.
F: wind speed value
Returns
I : 1 if success, NIL otherwise.

Definition at line 382 of file SCOLEnvironment.cpp.

◆ SO3EnvironmentUnregisterViewport()

int SO3EnvironmentUnregisterViewport ( mmachine  m)

SO3EnvironmentUnregisterViewport :

Prototype: fun [SO3_SCENE SO3_VIEWPORT] I

Parameters
SO3_SCENE: The scene on which we want to deactivate the environment rendering
SO3_VIEWPORT: The viewport to deactivate.
Returns
I : 1 if success , NIL otherwise

Definition at line 115 of file SCOLEnvironment.cpp.

◆ SO3MoonGetLightColor()

int SO3MoonGetLightColor ( mmachine  m)

SO3MoonGetLightColor :

Prototype:fun [SO3_SCENE] I

Parameters
SO3_SCENE: The scene on which we want to get the moon light color
Returns
I : The moon light color

Definition at line 4268 of file SCOLEnvironment.cpp.

◆ SO3MoonGetTexturePath()

int SO3MoonGetTexturePath ( mmachine  m)

SO3MoonGetLightColor :

Prototype:fun [SO3_SCENE] S

Parameters
SO3_SCENE: The scene on which we want to get the moon texture
Returns
S : The name of the texture in use for rendering the moon

Definition at line 4364 of file SCOLEnvironment.cpp.

◆ SO3MoonSetLightColor()

int SO3MoonSetLightColor ( mmachine  m)

SO3MoonSetLightColor :

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: The scene on which we want to set the moon light color
I: The moon color
Returns
I : 1 if success, NIL otherwise.

Definition at line 4316 of file SCOLEnvironment.cpp.

◆ SO3MoonSetTexturePath()

int SO3MoonSetTexturePath ( mmachine  m)

SO3MoonSetTexturePath :

Prototype: fun [SO3_SCENE S] I

Parameters
SO3_SCENE: The scene on which we want to set the moon texture
S: The new texture filename to use for the moon
Returns
I : 1 if success, NIL otherwise.

Definition at line 4410 of file SCOLEnvironment.cpp.

◆ SO3SkyAddLayeredCloud()

int SO3SkyAddLayeredCloud ( mmachine  m)

SO3SkyAddLayeredCloud :

Prototype:fun [SO3_SCENE] I

Parameters
SO3_SCENE: The scene on which we want to add a layered cloud layer
F: the
Returns
I : the index of the added layer

Definition at line 3603 of file SCOLEnvironment.cpp.

◆ SO3SkyAddLightning()

int SO3SkyAddLightning ( mmachine  m)

SO3SkyAddLightning : Set the sky Lightning state, the sky component must be set on SO3_SKY_COMPONENT_VOLUMETRIC_CLOUD.

Prototype: fun [SO3_SCENE [F F F] [F F F] F] I

Parameters
SO3_SCENE: The scene
[FF F] : position of the lightning
[FF F] : direction of the lightning
F: length of the lightning
Returns
I : 1 if success, NIL otherwise.

Definition at line 4079 of file SCOLEnvironment.cpp.

◆ SO3SkyComponentGetEnabled()

int SO3SkyComponentGetEnabled ( mmachine  m)

SO3SkyComponentGetEnabled :

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: The scene on which we want to know if the sky subcomponents is activated
I: Component type
Returns
I : 1 if the sky subcomponent is activated, 0 otherwise. NIL if error occurs.

Component type values are :

  • SO3_SKY_COMPONENT_LAYERER_CLOUD
  • SO3_SKY_COMPONENT_VOLUMETRIC_CLOUD

Definition at line 1401 of file SCOLEnvironment.cpp.

◆ SO3SkyComponentSetEnabled()

int SO3SkyComponentSetEnabled ( mmachine  m)

SO3SkyComponentSetEnabled :

Prototype: fun [SO3_SCENE I I] I

Parameters
SO3_SCENE: The scene on which we want to activate/deactivate the sky subcomponent
I: Sky component type
I: 1 to activate the subcomponent, 0 to disable it.

Component type values are :

  • SO3_SKY_COMPONENT_LAYERER_CLOUD
  • SO3_SKY_COMPONENT_VOLUMETRIC_CLOUD

Definition at line 1466 of file SCOLEnvironment.cpp.

◆ SO3SkyGetAnimationSpeed()

int SO3SkyGetAnimationSpeed ( mmachine  m)

SO3SkyGetAnimationSpeed :

Prototype:fun [SO3_SCENE] F

Parameters
SO3_SCENE: The scene on which the sky is rendered
Returns
F : Return the clouds animation speed. Can be negative. If value is "0", the clouds are frozen.

Definition at line 3313 of file SCOLEnvironment.cpp.

◆ SO3SkyGetCloudCeiling()

int SO3SkyGetCloudCeiling ( mmachine  m)

SO3SkyGetCloudCeiling :

Prototype:fun [SO3_SCENE] F

Parameters
SO3_SCENE: The scene on which the sky is rendered
Returns
F : Return the clouds ceiling height, ie, the height above ground at which clouds starts.

Definition at line 3509 of file SCOLEnvironment.cpp.

◆ SO3SkyGetEnable()

int SO3SkyGetEnable ( mmachine  m)

SO3SkyGetEnable :

Prototype: fun [SO3_SCENE] I

Parameters
SO3_SCENE: The scene on which we want to know if the sky rendering is activated
Returns
I : 1 if the sky rendering is activated, 0 otherwise. NIL if error occurs.

Definition at line 1308 of file SCOLEnvironment.cpp.

◆ SO3SkyGetHdrEnable()

int SO3SkyGetHdrEnable ( mmachine  m)

SO3SkyGetHdrEnable :

Prototype: fun [SO3_SCENE] I

Parameters
SO3_SCENE: The scene on which we want to know if the sky HDR rendering mode is activated
Returns
I : 1 if the sky HDR rendering mode is activated, 0 otherwise. NIL if error occurs.

Definition at line 3409 of file SCOLEnvironment.cpp.

◆ SO3SkyGetLayeredCloudIndexes()

int SO3SkyGetLayeredCloudIndexes ( mmachine  m)

SO3SkyGetLayeredCloudIndexes :

Prototype:fun [SO3_SCENE] [I r1]

Parameters
SO3_SCENE: The scene on which we want to retrieve the layers index of the layered cloud
Returns
[I r1] : list of the layer indexes

Definition at line 3706 of file SCOLEnvironment.cpp.

◆ SO3SkyGetLayeredCloudParameters()

int SO3SkyGetLayeredCloudParameters ( mmachine  m)

SO3SkyGetLayeredCloudParameters :

Prototype:fun [SO3_SCENE I] [F F F F F F]

Parameters
SO3_SCENE: The scene on which the sky is rendered
I: the cloud layer index.
Returns
[F F F F F F F] : The layer cloud parameters, for layered clouds
  • F : height from cloud ceiling
  • F : scale
  • F : attenuation distance
  • F : attenuation detail
  • F : height volume
  • F : volumetric displacement

Definition at line 3793 of file SCOLEnvironment.cpp.

◆ SO3SkyGetVolumetricCloudParameters()

int SO3SkyGetVolumetricCloudParameters ( mmachine  m)

SO3SkyGetVolumetricCloudParameters :

Prototype:fun [SO3_SCENE] [F F F]

Parameters
SO3_SCENE: The scene on which the water is rendered
Returns
[F F F] : The underwater "gods ray" parameters, for water rendering
  • F : intensity
  • F : speed
  • F : ray size

Definition at line 4143 of file SCOLEnvironment.cpp.

◆ SO3SkyRemoveLayeredCloud()

int SO3SkyRemoveLayeredCloud ( mmachine  m)

SO3SkyAddLayeredCloud :

Prototype:fun [SO3_SCENE I] I

Parameters
SO3_SCENE: The scene on which we want to add a layered cloud layer
I: the index of the layer to remove
Returns
I : 1 if success, NIL otherwise.

Definition at line 3651 of file SCOLEnvironment.cpp.

◆ SO3SkySetAnimationSpeed()

int SO3SkySetAnimationSpeed ( mmachine  m)

SO3SkySetAnimationSpeed :

Prototype:fun [SO3_SCENE F] I

Parameters
SO3_SCENE: The scene on which the sky is rendered
I: Set the clouds animation speed. Can be negative. If value is "0", the clouds will be frozen.
Returns
I : 1 if success, NIL otherwise.

Definition at line 3361 of file SCOLEnvironment.cpp.

◆ SO3SkySetCloudCeiling()

int SO3SkySetCloudCeiling ( mmachine  m)

SO3SkySetCloudCeiling :

Prototype:fun [SO3_SCENE F] I

Parameters
SO3_SCENE: The scene on which the sky is rendered
F: set the clouds ceiling height, ie, the height above ground at which clouds starts.
Returns
I : 1 if success, NIL otherwise.

Definition at line 3556 of file SCOLEnvironment.cpp.

◆ SO3SkySetEnable()

int SO3SkySetEnable ( mmachine  m)

SO3SkySetEnable :

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: The scene on which we want to activate the sky rendering
I: 1 to activate the sky rendering, 0 to disable it
Returns
I : 1 if success, NIL otherwise.

Definition at line 1351 of file SCOLEnvironment.cpp.

◆ SO3SkySetHdrEnable()

int SO3SkySetHdrEnable ( mmachine  m)

SO3SkySetHdrEnable :

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: The scene on which we want to activate the water sky HDR rendering
I: 1 to activate the HDR rendering mode, 0 to disable it (LDR mode)
Returns
I : 1 if success, NIL otherwise.

Definition at line 3458 of file SCOLEnvironment.cpp.

◆ SO3SkySetLayeredCloudParameters()

int SO3SkySetLayeredCloudParameters ( mmachine  m)

SO3SkySetLayeredCloudParameters :

Prototype: fun [SO3_SCENE I F F F F F F] I

Parameters
SO3_SCENE: The scene on which we want to set the cloud layer properties
I: the cloud layer index.
F: height from cloud ceiling (NIL to keep existing value)
F: scale (NIL to keep existing value)
F: attenuation distance (NIL to keep existing value)
F: attenuation detail (NIL to keep existing value)
F: height volume (NIL to keep existing value)
F: volumetric displacement (NIL to keep existing value)
Returns
I : 1 if success, NIL otherwise.

Definition at line 3888 of file SCOLEnvironment.cpp.

◆ SO3SkySetLightningEnable()

int SO3SkySetLightningEnable ( mmachine  m)

SO3SkySetLightningEnable : Set the sky Lightning state, the sky component must be set on SO3_SKY_COMPONENT_VOLUMETRIC_CLOUD.

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: The scene
I: 1 to activate the sky Lightning, 0 to disable it
Returns
I : 1 if success, NIL otherwise.

Definition at line 4025 of file SCOLEnvironment.cpp.

◆ SO3SunGetLightColor()

int SO3SunGetLightColor ( mmachine  m)

SO3SunGetLightColor :

Prototype:fun [SO3_SCENE] I

Parameters
SO3_SCENE: The scene on which we want to get the sun light color
Returns
I : The sun light color

Definition at line 4171 of file SCOLEnvironment.cpp.

◆ SO3SunSetLightColor()

int SO3SunSetLightColor ( mmachine  m)

SO3SunSetLightColor :

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: The scene on which we want to set the sun light color
I: The sun color
Returns
I : 1 if success, NIL otherwise.

Definition at line 4220 of file SCOLEnvironment.cpp.

◆ SO3WaterComponentGetEnabled()

int SO3WaterComponentGetEnabled ( mmachine  m)

SO3WaterComponentGetEnabled :

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: The scene on which we want to know if the water subcomponent is activated
I: Component type
Returns
I : 1 if the water subcomponent is activated, 0 otherwise. NIL if error occurs.

Component type values are :

  • SO3_WATER_COMPONENT_SUN
  • SO3_WATER_COMPONENT_FOAM
  • SO3_WATER_COMPONENT_DEPTH
  • SO3_WATER_COMPONENT_SMOOTH
  • SO3_WATER_COMPONENT_CAUSTICS
  • SO3_WATER_COMPONENT_UNDERWATER
  • SO3_WATER_COMPONENT_UNDERWATER_REFLECTIONS
  • SO3_WATER_COMPONENT_GODRAYS

Definition at line 1176 of file SCOLEnvironment.cpp.

◆ SO3WaterComponentSetEnabled()

int SO3WaterComponentSetEnabled ( mmachine  m)

SO3WaterComponentSetEnabled :

Prototype: fun [SO3_SCENE I I] I

Parameters
SO3_SCENE: The scene on which we want to activate/deactivate the water subcomponent
I: Water component type
I: 1 to activate the subcomponent, 0 to disable it.
Returns
I : 1 if success, NIL otherwise.

Component type values are :

  • SO3_WATER_COMPONENT_SUN
  • SO3_WATER_COMPONENT_FOAM
  • SO3_WATER_COMPONENT_DEPTH
  • SO3_WATER_COMPONENT_SMOOTH
  • SO3_WATER_COMPONENT_CAUSTICS
  • SO3_WATER_COMPONENT_UNDERWATER
  • SO3_WATER_COMPONENT_UNDERWATER_REFLECTIONS
  • SO3_WATER_COMPONENT_GODRAYS

Definition at line 1248 of file SCOLEnvironment.cpp.

◆ SO3WaterGetAnimationSpeed()

int SO3WaterGetAnimationSpeed ( mmachine  m)

SO3WaterGetAnimationSpeed :

Prototype:fun [SO3_SCENE] F

Parameters
SO3_SCENE: The scene on which the water is rendered
Returns
F : Return the waves animation speed. Can be negative. If value is "0", the waves are frozen.

Definition at line 1749 of file SCOLEnvironment.cpp.

◆ SO3WaterGetCausticsParameters()

int SO3WaterGetCausticsParameters ( mmachine  m)

SO3WaterGetCausticsParameters :

Prototype:fun [SO3_SCENE] [F F F]

Parameters
SO3_SCENE: The scene on which the water is rendered
Returns
[F F F] : The caustics parameters, for water rendering
  • F : caustic scale
  • F : caustic power
  • F : caustic end

Definition at line 2362 of file SCOLEnvironment.cpp.

◆ SO3WaterGetColor()

int SO3WaterGetColor ( mmachine  m)

SO3WaterGetColor :

Prototype:fun [SO3_SCENE] I

Parameters
SO3_SCENE: The scene on which the water is rendered
Returns
I : The water color

Definition at line 1654 of file SCOLEnvironment.cpp.

◆ SO3WaterGetDepthParameters()

int SO3WaterGetDepthParameters ( mmachine  m)

SO3WaterGetDepthParameters :

Prototype:fun [SO3_SCENE] [F F]

Parameters
SO3_SCENE: The scene on which the water is rendered
Returns
[F F] : The depth parameters, for water rendering
  • F : depth maximum attenuation based on distance along Y axis from water plane Y position (surface position).
  • F : depth maximum attenuation based on distance from current rendering camera

Definition at line 2155 of file SCOLEnvironment.cpp.

◆ SO3WaterGetEnable()

int SO3WaterGetEnable ( mmachine  m)

SO3WaterGetEnable :

Prototype: fun [SO3_SCENE] I

Parameters
SO3_SCENE: The scene on which we want to know if the water rendering is activated
Returns
I : 1 if the water rendering is activated, 0 otherwise. NIL if error occurs.

Definition at line 1077 of file SCOLEnvironment.cpp.

◆ SO3WaterGetFftNoiseParameters()

int SO3WaterGetFftNoiseParameters ( mmachine  m)

SO3WaterGetFftNoiseParameters :

Prototype:fun [SO3_SCENE] [F F F F I F [F F F] F]

Parameters
SO3_SCENE: The scene on which the water is rendered
Returns
[F F F F I F [F F F] F] : The fft noise parameters, for water rendering
  • F : scale
  • F : animation speed
  • F : amplitude
  • F : Kw factor
  • I : resolution
  • F : physical resolution
  • [F F F] : GPU LOD parameters (x -> Initial LOD value (Bigger values -> less detail), y -> Final LOD value, z -> Final distance)
  • F : GPU strength

Definition at line 2888 of file SCOLEnvironment.cpp.

◆ SO3WaterGetFoamParameters()

int SO3WaterGetFoamParameters ( mmachine  m)

SO3WaterGetFoamParameters :

Prototype:fun [SO3_SCENE] [F F F F]

Parameters
SO3_SCENE: The scene on which the water is rendered
Returns
[F F F F] : The foam parameters, for water rendering
  • F : maximum visibility distance
  • F : scale
  • F : start
  • F : transparency power

Definition at line 2010 of file SCOLEnvironment.cpp.

◆ SO3WaterGetGeometryComplexity()

int SO3WaterGetGeometryComplexity ( mmachine  m)

SO3WaterGetGeometryComplexity : Set the water mesh complexity.

Prototype:fun [SO3_SCENE] I

Parameters
SO3_SCENE: The scene on which the water is rendered
Returns
I : The water mesh complexity, for water rendering

Definition at line 3205 of file SCOLEnvironment.cpp.

◆ SO3WaterGetGodRaysParameters()

int SO3WaterGetGodRaysParameters ( mmachine  m)

SO3WaterGetGodRaysParameters :

Prototype:fun [SO3_SCENE] [[F F F] F F I F I]

Parameters
SO3_SCENE: The scene on which the water is rendered
Returns
[[F F F] F F I F I] : The underwater "gods ray" parameters, for water rendering
  • [F F F] : exposure
  • F : intensity
  • F : speed
  • I : number of rays
  • F : ray size
  • I : enable object intersection (1=true, 0=false).

Definition at line 2501 of file SCOLEnvironment.cpp.

◆ SO3WaterGetPerlinNoiseParameters()

int SO3WaterGetPerlinNoiseParameters ( mmachine  m)

SO3WaterGetPerlinNoiseParameters :

Prototype:fun [SO3_SCENE] [F I F F F [F F F] F]

Parameters
SO3_SCENE: The scene on which the water is rendered
Returns
[F I F F F [F F F] F] : The perlin noise parameters, for water rendering
  • F : scale
  • I : octaves
  • F : falloff
  • F : animation speed
  • F : time multiplier
  • [F F F] : GPU LOD parameters (x -> Initial LOD value (Bigger values -> less detail), y -> Final LOD value, z -> Final distance)
  • F : GPU strength

Definition at line 2692 of file SCOLEnvironment.cpp.

◆ SO3WaterGetPosition()

int SO3WaterGetPosition ( mmachine  m)

SO3WaterGetPosition :

Prototype:fun [SO3_SCENE] [F F F]

Parameters
SO3_SCENE: The scene on which the water is rendered
Returns
[F F F] : The water plane position vector, "y" being the sea level.

Definition at line 1527 of file SCOLEnvironment.cpp.

◆ SO3WaterGetSmoothPower()

int SO3WaterGetSmoothPower ( mmachine  m)

SO3WaterGetSmoothPower :

Prototype:fun [SO3_SCENE] F

Parameters
SO3_SCENE: The scene on which the water is rendered
Returns
F : The waves smooth power parameter, for water rendering

Definition at line 2264 of file SCOLEnvironment.cpp.

◆ SO3WaterGetSunParameters()

int SO3WaterGetSunParameters ( mmachine  m)

SO3WaterGetSunParameters :

Prototype:fun [SO3_SCENE] [[F F F] F F I]

Parameters
SO3_SCENE: The scene on which the water is rendered
Returns
[[F F F] F F I] : The sun parameters, for water rendering
  • [F F F] : sun position in world space
  • F : sun strength
  • F : sun area
  • I : sun color

Definition at line 1848 of file SCOLEnvironment.cpp.

◆ SO3WaterGetWaveParameters()

int SO3WaterGetWaveParameters ( mmachine  m)

SO3WaterGetWaveParameters : Get the water mesh parameters.

Prototype:fun [SO3_SCENE] [F F F]

Parameters
SO3_SCENE: The scene on which the water is rendered
Returns
[F F F] : The wave parameters, for water rendering
  • F : strength
  • F : elevation
  • F : choppy strength

Definition at line 3089 of file SCOLEnvironment.cpp.

◆ SO3WaterSetAnimationSpeed()

int SO3WaterSetAnimationSpeed ( mmachine  m)

SO3WaterSetAnimationSpeed :

Prototype:fun [SO3_SCENE F] I

Parameters
SO3_SCENE: The scene on which the water is rendered
I: Set the waves animation speed. Can be negative. If value is "0", the waves will be frozen.
Returns
I : 1 if success, NIL otherwise.

Definition at line 1797 of file SCOLEnvironment.cpp.

◆ SO3WaterSetCausticsParameters()

int SO3WaterSetCausticsParameters ( mmachine  m)

SO3WaterSetCausticsParameters :

Prototype: fun [SO3_SCENE F F F] I

Parameters
SO3_SCENE: The scene on which the water is rendered
F: caustic scale (NIL to keep existing value)
F: caustic power (NIL to keep existing value)
F: caustic end (NIL to keep existing value)
Returns
I : 1 if success, NIL otherwise.

Definition at line 2433 of file SCOLEnvironment.cpp.

◆ SO3WaterSetColor()

int SO3WaterSetColor ( mmachine  m)

SO3WaterSetColor :

Prototype:fun [SO3_SCENE I] I

Parameters
SO3_SCENE: The scene on which the water is rendered
I: The color of the water
Returns
I : 1 if success, NIL otherwise.

Definition at line 1701 of file SCOLEnvironment.cpp.

◆ SO3WaterSetDepthParameters()

int SO3WaterSetDepthParameters ( mmachine  m)

SO3WaterSetDepthParameters :

Prototype:fun [SO3_SCENE F F] I

Parameters
SO3_SCENE: The scene on which the water is rendered
F: depth maximum attenuation based on distance along Y axis from water plane Y position (surface position). NIL to keep existing value.
F: depth maximum attenuation based on distance from current rendering camera. NIL to keep existing value.
Returns
I : 1 if success, NIL otherwise.

Definition at line 2212 of file SCOLEnvironment.cpp.

◆ SO3WaterSetEnable()

int SO3WaterSetEnable ( mmachine  m)

SO3WaterSetEnable :

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: The scene on which we want to activate the water rendering
I: 1 to activate the water rendering, 0 to disable it
Returns
I : 1 if success, NIL otherwise.

Definition at line 1120 of file SCOLEnvironment.cpp.

◆ SO3WaterSetFftNoiseParameters()

int SO3WaterSetFftNoiseParameters ( mmachine  m)

SO3WaterSetFftNoiseParameters :

Prototype: fun [SO3_SCENE F F F F I F [F F F] F] I

Parameters
SO3_SCENE: The scene on which the water is rendered
F: scale (NIL to keep existing value)
F: animation speed (NIL to keep exising value)
F: amplitude (NIL to keep exising value)
F: Kw factor (NIL to keep exising value)
I: resolution (NIL to keep exising value)
F: physical resolution (NIL to keep existing value)
[FF F] : GPU LOD parameters (x -> Initial LOD value (Bigger values -> less detail), y -> Final LOD value, z -> Final distance, use NIL to keep existing value)
F: GPU strength (NIL to keep existing value)
Returns
I : 1 if success, NIL otherwise.

Definition at line 2992 of file SCOLEnvironment.cpp.

◆ SO3WaterSetFoamParameters()

int SO3WaterSetFoamParameters ( mmachine  m)

SO3WaterSetFoamParameters :

Prototype: fun [SO3_SCENE F F F F] I

Parameters
SO3_SCENE: The scene on which the water is rendered
F: maximum visibility distance (NIL to keep existing value)
F: scale (NIL to keep existing value)
F: start (NIL to keep existing value)
F: transparency power (NIL to keep existing value)
Returns
I : 1 if success, NIL otherwise.

Definition at line 2086 of file SCOLEnvironment.cpp.

◆ SO3WaterSetGeometryComplexity()

int SO3WaterSetGeometryComplexity ( mmachine  m)

SO3WaterSetGeometryComplexity : Set the water mesh complexity.

Prototype: fun [SO3_SCENE I] I

Parameters
SO3_SCENE: The scene on which the water is rendered
I: complexity
Returns
I : 1 if success, NIL otherwise.

Definition at line 3259 of file SCOLEnvironment.cpp.

◆ SO3WaterSetGodRaysParameters()

int SO3WaterSetGodRaysParameters ( mmachine  m)

SO3WaterSetGodRaysParameters :

Prototype: fun [SO3_SCENE [F F F] F F I F I] I

Parameters
SO3_SCENE: The scene on which the water is rendered
[FF F] : exposure (NIL to keep existing value)
F: intensity (NIL to keep existing value)
speed (NIL to keep existing value)
number of rays (NIL to keep existing value)
ray size (NIL to keep existing value)
enable object intersection (1=true, 0=false) (NIL to keep existing value)
Returns
I : 1 if success, NIL otherwise.

Definition at line 2599 of file SCOLEnvironment.cpp.

◆ SO3WaterSetPerlinNoiseParameters()

int SO3WaterSetPerlinNoiseParameters ( mmachine  m)

SO3WaterSetPerlinNoiseParameters :

Prototype: fun [SO3_SCENE F I F F F [F F F] F] I

Parameters
SO3_SCENE: The scene on which the water is rendered
F: scale (NIL to keep existing value)
I: octaves (NIL to keep existing value)
F: falloff (NIL to keep existing value)
F: animation speed (NIL to keep existing value)
F: time multiplier (NIL to keep existing value)
[FF F] : GPU LOD parameters (x -> Initial LOD value (Bigger values -> less detail), y -> Final LOD value, z -> Final distance, use NIL to keep existing value)
F: GPU strength (NIL to keep existing value)
Returns
I : 1 if success, NIL otherwise.

Definition at line 2791 of file SCOLEnvironment.cpp.

◆ SO3WaterSetPosition()

int SO3WaterSetPosition ( mmachine  m)

SO3WaterSetPosition :

Prototype:fun [SO3_SCENE [F F F]] I

Parameters
SO3_SCENE: The scene on which the water is rendered
[FF F] : Water plane position vector, "y" is sea level.
Returns
I : 1 if success, NIL otherwise.

Definition at line 1585 of file SCOLEnvironment.cpp.

◆ SO3WaterSetSmoothPower()

int SO3WaterSetSmoothPower ( mmachine  m)

SO3WaterSetSmoothPower :

Prototype:fun [SO3_SCENE F] I

Parameters
SO3_SCENE: The scene on which the water is rendered
F: The waves smooth power parameter, for water rendering
Returns
I : 1 if success, NIL otherwise.

Definition at line 2312 of file SCOLEnvironment.cpp.

◆ SO3WaterSetSunParameters()

int SO3WaterSetSunParameters ( mmachine  m)

SO3WaterSetSunParameters :

Prototype: fun [SO3_SCENE [F F F] F F I] I

Parameters
SO3_SCENE: The scene on which the water is rendered
[FF F] : sun position in world space (NIL to keep existing value)
F: sun strength (NIL to keep existing value)
F: sun area (NIL to keep existing value)
I: sun color (NIL to keep existing value)
Returns
I : 1 if success, NIL otherwise.

Definition at line 1933 of file SCOLEnvironment.cpp.

◆ SO3WaterSetWaveParameters()

int SO3WaterSetWaveParameters ( mmachine  m)

SO3WaterSetWaveParameters : Set the water mesh parameters.

Prototype: fun [SO3_SCENE F F F] I

Parameters
SO3_SCENE: The scene on which the water is rendered
F: strength
F: elevation
F: choppy strength
Returns
I : 1 if success, NIL otherwise.

Definition at line 3148 of file SCOLEnvironment.cpp.