WsfScriptZoneClass.cpp File Reference

#include "WsfScriptZoneClass.hpp"
#include <memory>
#include "UtLog.hpp"
#include "UtMemory.hpp"
#include "UtScriptColor.hpp"
#include "WsfDraw.hpp"
#include "WsfGeoPoint.hpp"
#include "WsfPlatform.hpp"
#include "WsfPlatformPart.hpp"
#include "WsfScenario.hpp"
#include "WsfScriptContext.hpp"
#include "WsfScriptManager.hpp"
#include "WsfSimulation.hpp"
#include "WsfZoneDefinition.hpp"
#include "WsfZoneSet.hpp"
#include "script/WsfScriptDefs.hpp"

Include dependency graph for WsfScriptZoneClass.cpp:

Functions
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, DebugDrawZone, 0, "void", "")
	zone.DebugDrawZone()
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, DebugDrawZoneRelative, 2, "void", "WsfGeoPoint, double")
	zone.DebugDrawZone()
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, DebugDrawCentroid, 0, "void", "")
	zone.DebugDrawCentroid()
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, DebugDrawBounds, 0, "void", "")
	zone.DebugDrawBounds()
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, Draw, 1, "void", "WsfDraw")
	zone.Draw()
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, DrawRelative, 3, "void", "WsfDraw, WsfGeoPoint, double")
	zone.DebugDrawZone()
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, DrawCentroid, 1, "void", "WsfDraw")
	zone.DebugDrawCentroid()
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, DrawBounds, 1, "void", "WsfDraw")
	zone.DebugDrawBounds()
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, MaxPoint, 0, "WsfGeoPoint", "")
	WsfGeoPoint max = zone.GetMaxPoint().
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, MinPoint, 0, "WsfGeoPoint", "")
	WsfGeoPoint min = zone.GetMinPoint().
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, ModifierValue, 1, "double", "string")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, Reference, 0, "WsfGeoPoint", "")
	WsfGeoPoint location = zone.Reference().
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, PenetrationDistance, 2, "double", "WsfGeoPoint, WsfGeoPoint")
	double penetrationDistance = zone.PenetrationDistance(WsfGeoPoint, WsfGeoPoint);
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, Position_1, 0, "WsfGeoPoint", "")
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, PointIsInside, 4, "bool", "WsfGeoPoint,WsfGeoPoint,double,double")
	zone.PointIsInside(WsfGeoPoint,WsfGeoPoint,double,double)
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, PointIsInside_2, 2, "bool", "WsfPlatform,WsfGeoPoint")
	zone.PointIsInside(WsfPlatform,WsfGeoPoint)
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, PointIsInside_3, 1, "bool", "WsfGeoPoint")
	zone.PointIsInside(WsfGeoPoint)
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, CreateCircular, 4, "WsfZone", "double,double,double,double")
	WsfZone.CreateCircular(double minRadius, double maxRadius, double startAngle, double stopAngle).
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, CreateElliptical, 4, "WsfZone", "double,double,double,double")
	WsfZone.CreateElliptical(double latAxis, double lonAxis, double startAngle, double stopAngle).
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, CreateSpherical, 4, "WsfZone", "double,double,double,double")
	WsfZone.CreateSpherical(double minRadius, double maxRadius, double startAngle, double stopAngle).
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, CreatePolygonalAbsolute, 1, "WsfZone", "Array<WsfGeoPoint>")
	WsfZone.CreatePolygonal(Array<WsfGeoPoint>).
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, CreatePolygonalRelative, 2, "WsfZone", "WsfPlatform, Array<Vec3>")
	WsfZone.CreatePolygonal(WsfPlatform, Array<Vec3>).
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, FindZone, 1, "WsfZone", "string")
	WsfZone.FindZone(string).
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, SetPolyPoints, 1, "void", "Array<WsfGeoPoint>")
	WsfZone.SetPolyPoints(Array<WsfGeoPoint>).
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, PolyPoints, 0, "Array<WsfGeoPoint>", "")
	Array<WsfGeoPoint> WsfZone.PolyPoints().
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, GetFillColor, 0, "Color", "")
	WsfZone.GetFillColor().
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, GetLineColor, 0, "Color", "")
	WsfZone.GetLineColor().
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, SetFillColor, 1, "void", "Color")
	WsfZone.SetFillColor().
	UT_DEFINE_SCRIPT_METHOD (WsfScriptZoneClass, WsfZone, SetLineColor, 1, "void", "Color")
	WsfZone.SetLineColor().

Function Documentation

UT_DEFINE_SCRIPT_METHOD() [1/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		CreateCircular	,
		4	,
		"WsfZone"	,
		" double	,
		double	,
		double	,
		double"	)

WsfZone.CreateCircular(double minRadius, double maxRadius, double startAngle, double stopAngle).

References WsfZoneDefinition::cCIRCULAR.

UT_DEFINE_SCRIPT_METHOD() [2/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		CreateElliptical	,
		4	,
		"WsfZone"	,
		" double	,
		double	,
		double	,
		double"	)

WsfZone.CreateElliptical(double latAxis, double lonAxis, double startAngle, double stopAngle).

References WsfZoneDefinition::cELLIPTICAL.

UT_DEFINE_SCRIPT_METHOD() [3/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		CreatePolygonalAbsolute	,
		1	,
		"WsfZone"	,
		"Array<WsfGeoPoint>"	)

WsfZone.CreatePolygonal(Array<WsfGeoPoint>).

References WsfZoneDefinition::cPOLYGONAL.

UT_DEFINE_SCRIPT_METHOD() [4/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		CreatePolygonalRelative	,
		2	,
		"WsfZone"	,
		"	WsfPlatform,
		Array< Vec3 >"	)

WsfZone.CreatePolygonal(WsfPlatform, Array<Vec3>).

References WsfZoneDefinition::cPOLYGONAL.

UT_DEFINE_SCRIPT_METHOD() [5/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		CreateSpherical	,
		4	,
		"WsfZone"	,
		" double	,
		double	,
		double	,
		double"	)

WsfZone.CreateSpherical(double minRadius, double maxRadius, double startAngle, double stopAngle).

References WsfZoneDefinition::cSPHERICAL.

UT_DEFINE_SCRIPT_METHOD() [6/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		DebugDrawBounds	,
		0	,
		"void"	,
		""	)

zone.DebugDrawBounds()

References SIMULATION.

UT_DEFINE_SCRIPT_METHOD() [7/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		DebugDrawCentroid	,
		0	,
		"void"	,
		""	)

zone.DebugDrawCentroid()

References SIMULATION.

UT_DEFINE_SCRIPT_METHOD() [8/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		DebugDrawZone	,
		0	,
		"void"	,
		""	)

zone.DebugDrawZone()

References SIMULATION.

UT_DEFINE_SCRIPT_METHOD() [9/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		DebugDrawZoneRelative	,
		2	,
		"void"	,
		"	WsfGeoPoint,
		double"	)

zone.DebugDrawZone()

References WsfGeoPoint::GetLocationWCS(), and SIMULATION.

UT_DEFINE_SCRIPT_METHOD() [10/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		Draw	,
		1	,
		"void"	,
		"WsfDraw"	)

zone.Draw()

UT_DEFINE_SCRIPT_METHOD() [11/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		DrawBounds	,
		1	,
		"void"	,
		"WsfDraw"	)

zone.DebugDrawBounds()

UT_DEFINE_SCRIPT_METHOD() [12/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		DrawCentroid	,
		1	,
		"void"	,
		"WsfDraw"	)

zone.DebugDrawCentroid()

UT_DEFINE_SCRIPT_METHOD() [13/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		DrawRelative	,
		3	,
		"void"	,
		"	WsfDraw,
		WsfGeoPoint	,
		double"	)

zone.DebugDrawZone()

References WsfGeoPoint::GetLocationWCS().

UT_DEFINE_SCRIPT_METHOD() [14/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		FindZone	,
		1	,
		"WsfZone"	,
		"string"	)

WsfZone.FindZone(string).

References WsfScriptContext::GetSCENARIO().

UT_DEFINE_SCRIPT_METHOD() [15/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		GetFillColor	,
		0	,
		"Color"	,
		""	)

WsfZone.GetFillColor().

UT_DEFINE_SCRIPT_METHOD() [16/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		GetLineColor	,
		0	,
		"Color"	,
		""	)

WsfZone.GetLineColor().

UT_DEFINE_SCRIPT_METHOD() [17/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		MaxPoint	,
		0	,
		"WsfGeoPoint"	,
		""	)

WsfGeoPoint max = zone.GetMaxPoint().

UT_DEFINE_SCRIPT_METHOD() [18/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		MinPoint	,
		0	,
		"WsfGeoPoint"	,
		""	)

WsfGeoPoint min = zone.GetMinPoint().

UT_DEFINE_SCRIPT_METHOD() [19/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		ModifierValue	,
		1	,
		"double"	,
		"string"	)

double value = zone.ModifierValue("<modifier_name>"); returns -1 if the modifier was not found.

UT_DEFINE_SCRIPT_METHOD() [20/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		PenetrationDistance	,
		2	,
		"double"	,
		"	WsfGeoPoint,
		WsfGeoPoint"	)

double penetrationDistance = zone.PenetrationDistance(WsfGeoPoint, WsfGeoPoint);

References WsfGeoPoint::GetLocationLLA().

UT_DEFINE_SCRIPT_METHOD() [21/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		PointIsInside	,
		4	,
		"bool"	,
		"	WsfGeoPoint,
		WsfGeoPoint	,
		double	,
		double"	)

zone.PointIsInside(WsfGeoPoint,WsfGeoPoint,double,double)

References WsfGeoPoint::GetLocationWCS(), and SIMULATION.

UT_DEFINE_SCRIPT_METHOD() [22/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		PointIsInside_2	,
		2	,
		"bool"	,
		"	WsfPlatform,
		WsfGeoPoint"	)

zone.PointIsInside(WsfPlatform,WsfGeoPoint)

References WsfZoneDefinition::cOBSERVER, WsfGeoPoint::GetLocationWCS(), WsfZoneDefinition::GetRelativeType(), platformPtr, WsfZoneDefinition::PointIsInside(), and SIMULATION.

UT_DEFINE_SCRIPT_METHOD() [23/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		PointIsInside_3	,
		1	,
		"bool"	,
		"WsfGeoPoint"	)

zone.PointIsInside(WsfGeoPoint)

References WsfZoneDefinition::cOBSERVER, WsfGeoPoint::GetLocationWCS(), WsfZoneDefinition::GetRelativeType(), and SIMULATION.

UT_DEFINE_SCRIPT_METHOD() [24/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		PolyPoints	,
		0	,
		"Array<WsfGeoPoint>"	,
		""	)

Array<WsfGeoPoint> WsfZone.PolyPoints().

References WsfZoneDefinition::cPOLYGONAL, WsfZoneDefinition::GetPoints(), and WsfZoneDefinition::GetShapeType().

UT_DEFINE_SCRIPT_METHOD() [25/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		Position_1	,
		0	,
		"WsfGeoPoint"	,
		""	)

WsfGeoPoint location = zone.Location() WsfGeoPoint location = zone.Position() WsfGeoPoint location = zone.Centroid()

UT_DEFINE_SCRIPT_METHOD() [26/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		Reference	,
		0	,
		"WsfGeoPoint"	,
		""	)

WsfGeoPoint location = zone.Reference().

References WsfZone::cUNSPECIFIED, WsfGeoPoint::GetLocationWCS(), WsfZoneDefinition::Reference(), SIMULATION, and WsfZoneDefinition::UpdateReference().

UT_DEFINE_SCRIPT_METHOD() [27/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		SetFillColor	,
		1	,
		"void"	,
		"Color"	)

WsfZone.SetFillColor().

References WsfZone::SetFillColor(), SIMULATION, and WsfObserver::ZoneFillColorChanged().

UT_DEFINE_SCRIPT_METHOD() [28/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		SetLineColor	,
		1	,
		"void"	,
		"Color"	)

WsfZone.SetLineColor().

References SIMULATION, and WsfObserver::ZoneLineColorChanged().

UT_DEFINE_SCRIPT_METHOD() [29/29]

UT_DEFINE_SCRIPT_METHOD	(	WsfScriptZoneClass	,
		WsfZone	,
		SetPolyPoints	,
		1	,
		"void"	,
		"Array<WsfGeoPoint>"	)

WsfZone.SetPolyPoints(Array<WsfGeoPoint>).

References WsfZoneDefinition::SetPolyPoints().