FormIt.SunAndLocation API

Description

Functions
json	FormIt.SunAndLocation.AddSatelliteImage (centerLat, centerLon, latSpan, lonSpan, pixelWidth, pixelHeight, physicalWidth, physicalHeight, address, xOffset, yOffset)
	AddSatelliteImage applies a placeholder satellite image.
json	FormIt.SunAndLocation.SetProjectAddress (address)
	SetProjectAddress sets the location address.
json	FormIt.SunAndLocation.GetProjectAddress ()
	GetProjectAddress returns the location address.
json	FormIt.SunAndLocation.SetLocation (longitude, latitude)
	SetLocation sets the location.
json	FormIt.SunAndLocation.SetTimeOfDay (dTimeOfDay, bUpdateRender, bForceUpdateShadows)
	SetTimeOfDay sets the time of day.
json	FormIt.SunAndLocation.UpdateShadows ()
	UpdateShadows updates the shadows.
json	FormIt.SunAndLocation.SetDate (nDay, nMonth, nYear, bUpdateRender, bForceUpdateShadows)
	SetDate sets the date.
json	FormIt.SunAndLocation.GetDaylightSavingTime ()
	GetDaylightSavingTime true if DST is active.
json	FormIt.SunAndLocation.SetDaylightSavingTime (bEnable, bUpdateRender)
	SetDaylightSavingTime sets DST on/off.
json	FormIt.SunAndLocation.GetLocationDateTime ()
	GetLocationDateTime Parameters: In: Out: {{"objectName", "SunLocationData", "latitude":, "longitude":, "Time":, "UTCTimeZone":, "DSTOffset":, "Day":, "Month":, "Year":, "DSTEnabled":};
json	FormIt.SunAndLocation.GetSunRiseAndSet ()
	GetSunRiseAndSet Parameters: In: Out: {"objectName"" "SunRiseData", sunRises":, sunRise":, sunSet":};
json	FormIt.SunAndLocation.GetLightDirectionFromLocationData (sunLocationData)
	GetLightDirectionFromLocationData Parameters: In:SunLocationData Out: {{"objectName", "Vector3d", "x":, "y":, "z": };

Function Documentation

AddSatelliteImage()

json FormIt.SunAndLocation.AddSatelliteImage	(	centerLat	,
		centerLon	,
		latSpan	,
		lonSpan	,
		pixelWidth	,
		pixelHeight	,
		physicalWidth	,
		physicalHeight	,
		address	,
		xOffset	,
		yOffset
	)

AddSatelliteImage applies a placeholder satellite image.

Parameters: In: centerLat, centerLon, latSpan, lonSpan, pixelWidth, pixelHeight, physicalWidth, physicalHeight, address

Parameters

[in]	xOffset	double x offset from origin (OPTIONAL)
[in]	yOffset	double x offset from origin (OPTIONAL) Out: ImageID
[in]	centerLat	double
[in]	centerLon	double
[in]	latSpan	double
[in]	lonSpan	double
[in]	pixelWidth	int
[in]	pixelHeight	int
[in]	physicalWidth	double
[in]	physicalHeight	double
[in]	address	String

Returns

imageID

GetDaylightSavingTime()

json FormIt.SunAndLocation.GetDaylightSavingTime

(

)

GetDaylightSavingTime true if DST is active.

Parameters: In: Out: bool

Returns

{...}

GetLightDirectionFromLocationData()

json FormIt.SunAndLocation.GetLightDirectionFromLocationData

(

sunLocationData

)

GetLightDirectionFromLocationData Parameters: In:SunLocationData Out: {{"objectName", "Vector3d", "x":, "y":, "z": };

Parameters

[in]

sunLocationData

FormIt.SunLocationData

Returns

{...}

GetLocationDateTime()

json FormIt.SunAndLocation.GetLocationDateTime

(

)

GetLocationDateTime Parameters: In: Out: {{"objectName", "SunLocationData", "latitude":, "longitude":, "Time":, "UTCTimeZone":, "DSTOffset":, "Day":, "Month":, "Year":, "DSTEnabled":};

Returns

{...}

GetProjectAddress()

json FormIt.SunAndLocation.GetProjectAddress

(

)

GetProjectAddress returns the location address.

Parameters: In: Out: string

Returns

{...}

GetSunRiseAndSet()

json FormIt.SunAndLocation.GetSunRiseAndSet

(

)

GetSunRiseAndSet Parameters: In: Out: {"objectName"" "SunRiseData", sunRises":, sunRise":, sunSet":};

Returns

{...}

SetDate()

json FormIt.SunAndLocation.SetDate	(	nDay	,
		nMonth	,
		nYear	,
		bUpdateRender	,
		bForceUpdateShadows
	)

SetDate sets the date.

Parameters: In: nDay, nMonth, nYear, bUpdateRender (OPTIONAL=true), bForceUpdateShadows(OPTIONAL=true) Out: JSON_UNDEFINED

Parameters

[in]	nDay	int
[in]	nMonth	int
[in]	nYear	int
[in]	bUpdateRender	(OPTIONAL, default = true) bool
[in]	bForceUpdateShadows	(OPTIONAL, default = true) bool

Returns

JSON_UNDEFINED, i.e. {}

SetDaylightSavingTime()

json FormIt.SunAndLocation.SetDaylightSavingTime	(	bEnable	,
		bUpdateRender
	)

SetDaylightSavingTime sets DST on/off.

Parameters: In: nDay, nMonth, nYear, bUpdateRender Out: JSON_UNDEFINED

Parameters

[in]	bEnable	bool
[in]	bUpdateRender	(OPTIONAL, default = true) bool

Returns

JSON_UNDEFINED, i.e. {}

SetLocation()

json FormIt.SunAndLocation.SetLocation	(	longitude	,
		latitude
	)

SetLocation sets the location.

Parameters: In: longitude, latitude Out: JSON_UNDEFINED

Parameters

[in]	longitude	double
[in]	latitude	double

Returns

JSON_UNDEFINED, i.e. {}

SetProjectAddress()

json FormIt.SunAndLocation.SetProjectAddress

(

address

)

SetProjectAddress sets the location address.

Parameters: In: address Out: JSON_UNDEFINED

Parameters

[in]

address

String

Returns

JSON_UNDEFINED, i.e. {}

SetTimeOfDay()

json FormIt.SunAndLocation.SetTimeOfDay	(	dTimeOfDay	,
		bUpdateRender	,
		bForceUpdateShadows
	)

SetTimeOfDay sets the time of day.

Parameters: In: dTimeOfDay, bUpdateRender (OPTIONAL=true), bForceUpdateShadows(OPTIONAL=true) Out: JSON_UNDEFINED

Parameters

[in]	dTimeOfDay	double
[in]	bUpdateRender	(OPTIONAL, default = true) bool
[in]	bForceUpdateShadows	(OPTIONAL, default = true) bool

Returns

JSON_UNDEFINED, i.e. {}

UpdateShadows()

json FormIt.SunAndLocation.UpdateShadows

(

)

UpdateShadows updates the shadows.

Parameters: In: Out: JSON_UNDEFINED

Returns

JSON_UNDEFINED, i.e. {}