Documentation

 

ITimeOfDay

Interface to the Time Of Day functionality. More...

#include

Public Types

enum ETimeOfDayParamID {
PARAM_SUN_COLOR, PARAM_SUN_INTENSITY, PARAM_SUN_SPECULAR_MULTIPLIER, PARAM_FOG_COLOR,
PARAM_FOG_COLOR_MULTIPLIER, PARAM_VOLFOG_HEIGHT, PARAM_VOLFOG_DENSITY, PARAM_FOG_COLOR2,
PARAM_FOG_COLOR2_MULTIPLIER, PARAM_VOLFOG_HEIGHT2, PARAM_VOLFOG_DENSITY2, PARAM_VOLFOG_HEIGHT_OFFSET,
PARAM_FOG_RADIAL_COLOR, PARAM_FOG_RADIAL_COLOR_MULTIPLIER, PARAM_VOLFOG_RADIAL_SIZE, PARAM_VOLFOG_RADIAL_LOBE,
PARAM_VOLFOG_FINAL_DENSITY_CLAMP, PARAM_VOLFOG_GLOBAL_DENSITY, PARAM_VOLFOG_RAMP_START, PARAM_VOLFOG_RAMP_END,
PARAM_VOLFOG_RAMP_INFLUENCE, PARAM_VOLFOG_SHADOW_DARKENING, PARAM_VOLFOG_SHADOW_DARKENING_SUN, PARAM_VOLFOG_SHADOW_DARKENING_AMBIENT,
PARAM_VOLFOG_SHADOW_RANGE, PARAM_VOLFOG2_HEIGHT, PARAM_VOLFOG2_DENSITY, PARAM_VOLFOG2_HEIGHT2,
PARAM_VOLFOG2_DENSITY2, PARAM_VOLFOG2_GLOBAL_DENSITY, PARAM_VOLFOG2_RAMP_START, PARAM_VOLFOG2_RAMP_END,
PARAM_VOLFOG2_COLOR1, PARAM_VOLFOG2_ANISOTROPIC1, PARAM_VOLFOG2_COLOR2, PARAM_VOLFOG2_ANISOTROPIC2,
PARAM_VOLFOG2_BLEND_FACTOR, PARAM_VOLFOG2_BLEND_MODE, PARAM_VOLFOG2_COLOR, PARAM_VOLFOG2_ANISOTROPIC,
PARAM_VOLFOG2_RANGE, PARAM_VOLFOG2_INSCATTER, PARAM_VOLFOG2_EXTINCTION, PARAM_VOLFOG2_GLOBAL_FOG_VISIBILITY,
PARAM_VOLFOG2_FINAL_DENSITY_CLAMP, PARAM_SKYLIGHT_SUN_INTENSITY, PARAM_SKYLIGHT_SUN_INTENSITY_MULTIPLIER, PARAM_SKYLIGHT_KM,
PARAM_SKYLIGHT_KR, PARAM_SKYLIGHT_G, PARAM_SKYLIGHT_WAVELENGTH_R, PARAM_SKYLIGHT_WAVELENGTH_G,
PARAM_SKYLIGHT_WAVELENGTH_B, PARAM_NIGHSKY_HORIZON_COLOR, PARAM_NIGHSKY_HORIZON_COLOR_MULTIPLIER, PARAM_NIGHSKY_ZENITH_COLOR,
PARAM_NIGHSKY_ZENITH_COLOR_MULTIPLIER, PARAM_NIGHSKY_ZENITH_SHIFT, PARAM_NIGHSKY_START_INTENSITY, PARAM_NIGHSKY_MOON_COLOR,
PARAM_NIGHSKY_MOON_COLOR_MULTIPLIER, PARAM_NIGHSKY_MOON_INNERCORONA_COLOR, PARAM_NIGHSKY_MOON_INNERCORONA_COLOR_MULTIPLIER, PARAM_NIGHSKY_MOON_INNERCORONA_SCALE,
PARAM_NIGHSKY_MOON_OUTERCORONA_COLOR, PARAM_NIGHSKY_MOON_OUTERCORONA_COLOR_MULTIPLIER, PARAM_NIGHSKY_MOON_OUTERCORONA_SCALE, PARAM_CLOUDSHADING_SUNLIGHT_MULTIPLIER,
PARAM_CLOUDSHADING_SKYLIGHT_MULTIPLIER, PARAM_CLOUDSHADING_SUNLIGHT_CUSTOM_COLOR, PARAM_CLOUDSHADING_SUNLIGHT_CUSTOM_COLOR_MULTIPLIER, PARAM_CLOUDSHADING_SUNLIGHT_CUSTOM_COLOR_INFLUENCE,
PARAM_VOLCLOUD_GLOBAL_DENSITY, PARAM_VOLCLOUD_HEIGHT, PARAM_VOLCLOUD_THICKNESS, PARAM_VOLCLOUD_CLOUD_EDGE_TURBULENCE,
PARAM_VOLCLOUD_CLOUD_EDGE_THRESHOLD, PARAM_VOLCLOUD_SUN_SINGLE_SCATTERING, PARAM_VOLCLOUD_SUN_LOW_ORDER_SCATTERING, PARAM_VOLCLOUD_SUN_LOW_ORDER_SCATTERING_ANISTROPY,
PARAM_VOLCLOUD_SUN_HIGH_ORDER_SCATTERING, PARAM_VOLCLOUD_SKY_LIGHTING_SCATTERING, PARAM_VOLCLOUD_GOUND_LIGHTING_SCATTERING, PARAM_VOLCLOUD_GROUND_LIGHTING_ALBEDO,
PARAM_VOLCLOUD_MULTI_SCATTERING_ATTENUATION, PARAM_VOLCLOUD_MULTI_SCATTERING_PRESERVATION, PARAM_VOLCLOUD_POWDER_EFFECT, PARAM_VOLCLOUD_ABSORPTION,
PARAM_VOLCLOUD_ATMOSPHERIC_ALBEDO, PARAM_VOLCLOUD_ATMOSPHERIC_SCATTERING, PARAM_VOLCLOUD_WIND_INFLUENCE, PARAM_SUN_SHAFTS_VISIBILITY,
PARAM_SUN_RAYS_VISIBILITY, PARAM_SUN_RAYS_ATTENUATION, PARAM_SUN_RAYS_SUNCOLORINFLUENCE, PARAM_SUN_RAYS_CUSTOMCOLOR,
PARAM_OCEANFOG_COLOR, PARAM_OCEANFOG_COLOR_MULTIPLIER, PARAM_OCEANFOG_DENSITY, PARAM_SKYBOX_MULTIPLIER,
PARAM_HDR_FILMCURVE_SHOULDER_SCALE, PARAM_HDR_FILMCURVE_LINEAR_SCALE, PARAM_HDR_FILMCURVE_TOE_SCALE, PARAM_HDR_FILMCURVE_WHITEPOINT,
PARAM_HDR_COLORGRADING_COLOR_SATURATION, PARAM_HDR_COLORGRADING_COLOR_BALANCE, PARAM_HDR_EYEADAPTATION_SCENEKEY, PARAM_HDR_EYEADAPTATION_MIN_EXPOSURE,
PARAM_HDR_EYEADAPTATION_MAX_EXPOSURE, PARAM_HDR_EYEADAPTATION_EV_MIN, PARAM_HDR_EYEADAPTATION_EV_MAX, PARAM_HDR_EYEADAPTATION_EV_AUTO_COMPENSATION,
PARAM_HDR_BLOOM_AMOUNT, PARAM_COLORGRADING_FILTERS_GRAIN, PARAM_COLORGRADING_FILTERS_PHOTOFILTER_COLOR, PARAM_COLORGRADING_FILTERS_PHOTOFILTER_DENSITY,
PARAM_COLORGRADING_DOF_FOCUSRANGE, PARAM_COLORGRADING_DOF_BLURAMOUNT, PARAM_SHADOWSC0_BIAS, PARAM_SHADOWSC0_SLOPE_BIAS,
PARAM_SHADOWSC1_BIAS, PARAM_SHADOWSC1_SLOPE_BIAS, PARAM_SHADOWSC2_BIAS, PARAM_SHADOWSC2_SLOPE_BIAS,
PARAM_SHADOWSC3_BIAS, PARAM_SHADOWSC3_SLOPE_BIAS, PARAM_SHADOWSC4_BIAS, PARAM_SHADOWSC4_SLOPE_BIAS,
PARAM_SHADOWSC5_BIAS, PARAM_SHADOWSC5_SLOPE_BIAS, PARAM_SHADOWSC6_BIAS, PARAM_SHADOWSC6_SLOPE_BIAS,
PARAM_SHADOWSC7_BIAS, PARAM_SHADOWSC7_SLOPE_BIAS, PARAM_SHADOW_JITTERING, PARAM_HDR_DYNAMIC_POWER_FACTOR,
PARAM_TERRAIN_OCCL_MULTIPLIER, PARAM_GI_MULTIPLIER, PARAM_SUN_COLOR_MULTIPLIER, PARAM_TOTAL
}
enum EVariableType { TYPE_FLOAT, TYPE_COLOR }

Public Member Functions

virtual int GetPresetCount () const =0
virtual bool GetPresetsInfos (SPresetInfo *resultArray, unsigned int arraySize) const =0
virtual bool SetCurrentPreset (const char *szPresetName)=0
virtual const char * GetCurrentPresetName () const =0
virtual bool AddNewPreset (const char *szPresetName)=0
virtual bool RemovePreset (const char *szPresetName)=0
virtual bool SavePreset (const char *szPresetName) const =0
virtual bool LoadPreset (const char *szFilePath)=0
virtual void ResetPreset (const char *szPresetName)=0
virtual bool ImportPreset (const char *szPresetName, const char *szFilePath)=0
virtual bool ExportPreset (const char *szPresetName, const char *szFilePath) const =0
virtual int GetVariableCount ()=0
Access to variables that control time of the day appearance.
virtual bool GetVariableInfo (int nIndex, SVariableInfo &varInfo)=0
virtual void SetVariableValue (int nIndex, float fValue[3])=0
virtual bool InterpolateVarInRange (int nIndex, float fMin, float fMax, unsigned int nCount, Vec3 *resultArray) const =0
Editor interface.
virtual uint GetSplineKeysCount (int nIndex, int nSpline) const =0
virtual bool GetSplineKeysForVar (int nIndex, int nSpline, SBezierKey *keysArray, unsigned int keysArraySize) const =0
virtual bool SetSplineKeysForVar (int nIndex, int nSpline, const SBezierKey *keysArray, unsigned int keysArraySize)=0
virtual bool UpdateSplineKeyForVar (int nIndex, int nSpline, float fTime, float newValue)=0
virtual float GetAnimTimeSecondsIn24h ()=0
virtual void ResetVariables ()=0
virtual void SetTime (float fHour, bool bForceUpdate=false)=0
Sets the time of the day specified in hours.
virtual float GetTime ()=0
virtual void SetSunPos (float longitude, float latitude)=0
Sun position.
virtual float GetSunLatitude ()=0
virtual float GetSunLongitude ()=0
virtual void Tick ()=0
Updates the current ToD.
virtual void SetPaused (bool paused)=0
virtual void SetAdvancedInfo (const SAdvancedInfo &advInfo)=0
virtual void GetAdvancedInfo (SAdvancedInfo &advInfo)=0
virtual void Update (bool bInterpolate=true, bool bForceUpdate=false)=0
Updates engine parameters after variable values have been changed.
virtual void BeginEditMode ()=0
virtual void EndEditMode ()=0
virtual void Serialize (XmlNodeRef &node, bool bLoading)=0
virtual void Serialize (TSerialize ser)=0
virtual void SetTimer (ITimer *pTimer)=0
virtual void SetEnvironmentSettings (const SEnvironmentInfo &envInfo)=0
virtual void NetSerialize (TSerialize ser, float lag, uint32 flags)=0
virtual void SaveInternalState (struct IDataWriteStream &writer)=0
LiveCreate.
virtual void LoadInternalState (struct IDataReadStream &reader)=0
bool RegisterListener (IListener *const pListener)
Listener registration.
bool RegisterListener (IListener *const pListener, const char *const szDbgName, const bool staticName)
void UnRegisterListener (IListener *const pListener)

Static Public Attributes

static const int NETSER_FORCESET = BIT(0)
Multiplayer serialization.
static const int NETSER_COMPENSATELAG = BIT(1)
static const int NETSER_STATICPROPS = BIT(2)

Protected Member Functions

virtual bool RegisterListenerImpl (IListener *const pListener, const char *const szDbgName, const bool staticName)=0
virtual void UnRegisterListenerImpl (IListener *const pListener)=0

Detailed Description

Interface to the Time Of Day functionality.

Crytek GmbH uses cookies on this website to improve your experience, analyze our traffic and integrate with social media. You may adjust cookie preferences by clicking “customize” or withdraw decision to accept or reject cookies at any time. Please find further information in our Privacy and Cookie policies.
Customize