FormIt C++ API  v23.0.0 (2023.0.0)
FormIt::SunAndLocation API

Description

Functions

FORMIT_CORE_EXPORT void FormIt::SunAndLocation::SetProjectAddress (1::string const &address)
 SetProjectAddress() function. More...
 
FORMIT_CORE_EXPORT size_t FormIt::SunAndLocation::AddSatelliteImage (double centerLat, double centerLon, double latSpan, double lonSpan, int pixelWidth, int pixelHeight, double physicalWidth, double physicalHeight, const 1::string &address, double xOffset=0.0, double yOffset=0.0)
 AddSatelliteImage() function. More...
 
FORMIT_CORE_EXPORT::string FormIt::SunAndLocation::GetProjectAddress ()
 GetProjectAddress() function. More...
 
FORMIT_CORE_EXPORT void FormIt::SunAndLocation::SetLocation (double longitude, double latitude, bool bUpdateRender=true)
 SetLocation() function. More...
 
FORMIT_CORE_EXPORT void FormIt::SunAndLocation::SetTimeOfDay (double dTimeOfDay, bool bUpdateRender=true, bool bForceUpdateShadows=true)
 SetTimeOfDay() function. More...
 
FORMIT_CORE_EXPORT void FormIt::SunAndLocation::UpdateShadows ()
 UpdateShadows() function. More...
 
FORMIT_CORE_EXPORT void FormIt::SunAndLocation::SetDate (int nDay, int nMonth, int nYear, bool bUpdateRender=true, bool bForceUpdateShadows=true)
 SetDate() function. More...
 
FORMIT_CORE_EXPORT bool FormIt::SunAndLocation::GetDaylightSavingTime ()
 GetDaylightSavingTime() function. More...
 
FORMIT_CORE_EXPORT void FormIt::SunAndLocation::SetDaylightSavingTime (bool bEnable, bool bUpdateRender=true)
 SetDaylightSavingTime() function. More...
 
FORMIT_CORE_EXPORT SunLocationData FormIt::SunAndLocation::GetLocationDateTime ()
 GetLocationDateTime() function. More...
 
FORMIT_CORE_EXPORT SunRiseData FormIt::SunAndLocation::GetSunRiseAndSet ()
 GetSunRiseAndSet() function. More...
 
FORMIT_CORE_EXPORT WSM::Vector3d FormIt::SunAndLocation::GetLightDirectionFromLocationData (const FormIt::SunLocationData &locationData)
 GetLightDirectionFromLocationData() function. More...
 

Function Documentation

FORMIT_CORE_EXPORT size_t FormIt::SunAndLocation::AddSatelliteImage ( double  centerLat,
double  centerLon,
double  latSpan,
double  lonSpan,
int  pixelWidth,
int  pixelHeight,
double  physicalWidth,
double  physicalHeight,
const 1::string &  address,
double  xOffset = 0.0,
double  yOffset = 0.0 
)

AddSatelliteImage() function.

Parameters
[in]centerLat
[in]centerLon
[in]latSpan
[in]lonSpan
[in]pixelWidth
[in]pixelHeight
[in]physicalWidth
[in]physicalHeight
[in]address
[in]xOffset
[in]yOffset
FORMIT_CORE_EXPORT bool FormIt::SunAndLocation::GetDaylightSavingTime ( )
FORMIT_CORE_EXPORT WSM::Vector3d FormIt::SunAndLocation::GetLightDirectionFromLocationData ( const FormIt::SunLocationData locationData)

GetLightDirectionFromLocationData() function.

Parameters
[in]locationData
FORMIT_CORE_EXPORT SunLocationData FormIt::SunAndLocation::GetLocationDateTime ( )
FORMIT_CORE_EXPORT ::string FormIt::SunAndLocation::GetProjectAddress ( )
FORMIT_CORE_EXPORT SunRiseData FormIt::SunAndLocation::GetSunRiseAndSet ( )

GetSunRiseAndSet() function.

FORMIT_CORE_EXPORT void FormIt::SunAndLocation::SetDate ( int  nDay,
int  nMonth,
int  nYear,
bool  bUpdateRender = true,
bool  bForceUpdateShadows = true 
)

SetDate() function.

Parameters
[in]nDay
[in]nMonth
[in]nYear
[in]bUpdateRender
[in]bForceUpdateShadows
FORMIT_CORE_EXPORT void FormIt::SunAndLocation::SetDaylightSavingTime ( bool  bEnable,
bool  bUpdateRender = true 
)

SetDaylightSavingTime() function.

Parameters
[in]bEnable
[in]bUpdateRender
FORMIT_CORE_EXPORT void FormIt::SunAndLocation::SetLocation ( double  longitude,
double  latitude,
bool  bUpdateRender = true 
)

SetLocation() function.

Parameters
[in]longitude
[in]latitude
[in]bUpdateRender
FORMIT_CORE_EXPORT void FormIt::SunAndLocation::SetProjectAddress ( 1::string const &  address)

SetProjectAddress() function.

Parameters
[in]address
FORMIT_CORE_EXPORT void FormIt::SunAndLocation::SetTimeOfDay ( double  dTimeOfDay,
bool  bUpdateRender = true,
bool  bForceUpdateShadows = true 
)

SetTimeOfDay() function.

Parameters
[in]dTimeOfDay
[in]bUpdateRender
[in]bForceUpdateShadows
FORMIT_CORE_EXPORT void FormIt::SunAndLocation::UpdateShadows ( )

UpdateShadows() function.