Detailed Description
Use this interface to access the sun and sky components of a daylight system created by IDaylightSystemFactory.
This interface can be obtained when the daylight system is created. See IDaylightSystemFactory::Create In the case of an already existent daylight system, this interface can be obtained from the base object of the daylight assembly:
Object* daylightAssemblyObj = ... BaseInterface* bi = daylightAssemblyObj->GetInterface(DAYLIGHT_SYSTEM_INTERFACE); IDaylightSystem* ds = dynamic_cast<IDaylightSystem*>(bi);
- See also:
- IDaylightSystemFactory
#include <IDaylightSystem.h>
Public Member Functions |
|
| virtual LightObject * | GetSun () const =0 |
| Returns the sun component of the daylight
system. |
|
| virtual LightObject * | GetSky () const =0 |
| Returns the sky component of the daylight
system. |
|
| virtual void | SetPosition (const Point3 &position)=0 |
| Sets the position of the compass of the
daylight system. |
|
| virtual Point3 | GetPosition () const =0 |
| Returns the position of the compass of the
daylight system. |
|
| virtual void | SetOrbitalScale (float orbScale)=0 |
| Sets the orbital scale of the system.
|
|
| virtual float | GetOrbitalScale () const =0 |
| Returns the orbital scale of the system.
|
|
| virtual void | SetNorthDirection (float angle)=0 |
| Sets the value of the north direction.
|
|
| virtual float | GetNorthDirection () const =0 |
| Returns the value of the north direction.
|
|
| virtual void | SetCompassDiameter (float compassDiameter)=0 |
| Sets the compass diameter of this daylight.
|
|
| virtual float | GetCompassDiameter () const =0 |
| Returns the compass diameter of this
daylight system. |
|
| virtual void | SetTimeOfDay (const Point3 &time)=0 |
| Sets the current time associated with this
daylight system. |
|
| virtual Point3 | GetTimeOfDay () const =0 |
| Returns the current time associated with
this daylight system. |
|
| virtual void | SetDate (const Point3 &date)=0 |
| Sets the current date associated to this
daylight system. |
|
| virtual Point3 | GetDate () const =0 |
| Returns the current date associated to this
daylight system. |
|
| virtual void | SetLatLong (float latitude, float longitude)=0 |
| Set the latitude and longitude of this
daylight system, note that the time zone, city, azimuth and
altitude are automatically calculated. |
|
| virtual float | GetLatitude () const =0 |
| Returns latitude value of this daylight
system. |
|
| virtual float | GetLongitude () const =0 |
| Longitude value of this daylight system.
|
|
| virtual void | SetDaylightSavingTime (BOOL isDaylightSavingTime)=0 |
| Set the daylight saving time parameter.
|
|
| virtual BOOL | GetDaylightSavingTime () const =0 |
| Returns the daylight saving time parameter.
|
|
Member Function Documentation
| virtual LightObject* GetSun | ( | ) | const [pure virtual] |
Returns the sun component of the daylight system.
It can be directional light, IES sun or MR sun depending on the market defaults.
- Returns:
- pointer on the sun.
| virtual LightObject* GetSky | ( | ) | const [pure virtual] |
Returns the sky component of the daylight system.
It can be standard sky, IES sky or MR sky depending on the market defaults.
- Returns:
- pointer on the sky.
| virtual void SetPosition | ( | const Point3 & | position | ) | [pure virtual] |
Sets the position of the compass of the daylight system.
- Parameters:
-
[in] position Origin position of the system
| virtual Point3 GetPosition | ( | ) | const [pure virtual] |
Returns the position of the compass of the daylight system.
- Returns:
- position of the compass of the daylight system.
| virtual void SetOrbitalScale | ( | float | orbScale | ) | [pure virtual] |
Sets the orbital scale of the system.
- Parameters:
-
[in] orbScale distance of the sun (the directional light) from the compass rose (orbital scale in the UI) Note that the orbital scale does not have an effect on the sun's precision or how it's rendered.
| virtual float GetOrbitalScale | ( | ) | const [pure virtual] |
Returns the orbital scale of the system.
- Returns:
- orbital scale value. Note that the orbital scale does not have an effect on the sun's precision or how it's rendered.
| virtual void SetNorthDirection | ( | float | angle | ) | [pure virtual] |
Sets the value of the north direction.
- Parameters:
-
[in] angle rotational direction of the compass rose in the scene (north direction in the UI) The angle is in degree. The value is expected to be >=0.
| virtual float GetNorthDirection | ( | ) | const [pure virtual] |
Returns the value of the north direction.
- Returns:
- the value of the north direction. The angle is in degree. The value is expected to be >=0.
| virtual void SetCompassDiameter | ( | float | compassDiameter | ) | [pure virtual] |
Sets the compass diameter of this daylight.
- Parameters:
-
[in] compassDiameter this parameter controls the diameter of the compass rose. Note that the compass diameter does not have an effect on the sun's precision or how it's rendered. The value is expected to be >=0.
| virtual float GetCompassDiameter | ( | ) | const [pure virtual] |
Returns the compass diameter of this daylight system.
Note that the compass diameter does not have an effect on the sun's precision or how it's rendered.
- Returns:
- compass diameter.
| virtual void SetTimeOfDay | ( | const Point3 & | time | ) | [pure virtual] |
Sets the current time associated with this daylight system.
- Parameters:
-
[in] time time of day. The expected format is : (hour,minute,second)
| virtual Point3 GetTimeOfDay | ( | ) | const [pure virtual] |
Returns the current time associated with this daylight system.
- Returns:
- current time of the daylight system. The format is : (hour,minute,second).
| virtual void SetDate | ( | const Point3 & | date | ) | [pure virtual] |
Sets the current date associated to this daylight system.
- Parameters:
-
[in] date date of the year. The expected format is : (month,day,year)
| virtual Point3 GetDate | ( | ) | const [pure virtual] |
Returns the current date associated to this daylight system.
- Returns:
- the current date associated to this daylight system. The format is (month,day,year).
| virtual void SetLatLong | ( | float | latitude, |
| float | longitude | ||
| ) | [pure virtual] |
Set the latitude and longitude of this daylight system, note that the time zone, city, azimuth and altitude are automatically calculated.
- Parameters:
-
[in] latitude latitude of the location (used to determine city) [in] longitude longitude of the location (used to determine city)
| virtual float GetLatitude | ( | ) | const [pure virtual] |
Returns latitude value of this daylight system.
- Returns:
- Latitude value of this daylight system.
| virtual float GetLongitude | ( | ) | const [pure virtual] |
Longitude value of this daylight system.
- Returns:
- Longitude value of this daylight system.
| virtual void SetDaylightSavingTime | ( | BOOL | isDaylightSavingTime | ) | [pure virtual] |
Set the daylight saving time parameter.
- Parameters:
-
[in] isDaylightSavingTime When on, calculates daylight savings by adjusting azimuth and altitude during the summer months.
| virtual BOOL GetDaylightSavingTime | ( | ) | const [pure virtual] |
Returns the daylight saving time parameter.
- Returns:
- isDaylightSavingTime When on, calculates daylight savings by adjusting azimuth and altitude during the summer months.
