A class for defining a zone. More...

#include <WsfZoneDefinition.hpp>

Inheritance diagram for WsfZoneDefinition:

[legend]

Collaboration diagram for WsfZoneDefinition:

[legend]

Public Types
enum	RelativeToType { cOBSERVER , cINTERNAL }
enum	ShapeType { cNO_SHAPE , cCIRCULAR , cELLIPTICAL , cPOLYGONAL , cSPHERICAL }
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Public Types inherited from WsfComponentT< WsfPlatform >
typedef WsfPlatform	ParentType
	This is needed to support the WsfComponentList template.

Public Member Functions
	WsfZoneDefinition ()
	WsfZoneDefinition (const WsfZoneDefinition &aSrc)
WsfZoneDefinition &	operator= (const WsfZoneDefinition &)=delete
	~WsfZoneDefinition () override=default
WsfZone *	Clone () const override
	The standard Clone() method (virtual copy constructor).
bool	PointIsInside (WsfSimulation *aSimulationPtr, const double aViewedPointWCS[3], const double aEyePointWCS[3], const double aLookHeading, const double aDeltaDownRange=0.0) override
double	CheckIntersections (const double aLLA1[3], const double aLLA2[3]) override
void	Initialize (const WsfScenario &aScenario) override
bool	ProcessInput (UtInput &aInput) override
void	UpdateReference (const WsfSimulation &aSimulation)
	Update the geometric reference point for the zone from the simulation.
void	SetReference (UtEntity &aReference)
	Set the geometric reference point for the zone.
void	SetReference (const WsfGeoPoint &aReference, double aReferenceHeading)
	Set the geometric reference point for the zone.
void	SetReference (double aReferenceWCS[3], double aReferenceHeading)
	Set the geometric reference point for the zone.
void	SetReference (double aReferenceLat, double aReferenceLon, double aReferenceHeading)
	Set the geodetic reference point for the zone.
WsfGeoPoint	Reference () override
	return the geopoint of the reference point
void	SetShapeType (ShapeType aType)
void	SetRelativeType (RelativeToType aType)
void	SetAltBounds (double aMinAlt, double aMaxAlt)
void	SetRadialBounds (double aMinRadius, double aMaxRadius)
void	SetAngleBounds (double aStartAngle, double aStopAngle)
void	SetEllipticalAxes (double aLatAxisLen, double aLonAxisLen)
void	SetPolyPoints (const std::vector< WsfGeoPoint > &aPoints)
void	SetPolyPointsRelative (const std::vector< UtVec3d > &aPoints)
const std::vector< WsfZone::Point > &	GetPoints () const
void	GetPoints (std::vector< WsfGeoPoint > &aPoints) const
ut::optional< UtColor >	GetFillColor () const override
ut::optional< UtColor >	GetLineColor () const override
ShapeType	GetShapeType () const
RelativeToType	GetRelativeType () const
WsfStringId	GetReferencePlatformName () const
double	GetReferenceLat () const
double	GetReferenceLon () const
bool	IsNegative () const
	Returns true the zone is a 'negative' zone and returns the opposite value for PointIsInside().
bool	HasAbsoluteLatLon () const
void	SetPointsAreLatLon (bool aValue)
bool	PointsAreLatLon ()
bool	GetLatLonExtrema (double &aSouthernLat, double &aWesternLon, double &aNorthernLat, double &aEasternLon) const override
double	GetRadius () const
double	GetMinRadius () const
double	GetReferenceHeading () const
double	GetLatAxisLength () const
double	GetLonAxisLength () const
void	GetAngleBounds (double &aStartAngle, double &aStopAngle) const
void	GetAltBounds (double &aMinAlt, double &aMaxAlt) const
WsfPlatform *	GetReferencePlatform (WsfSimulation *aSimulationPtr) const
void	VerticesIn (double aMinX, double aMinY, double aMaxX, double aMaxY, std::vector< Point > &aPointsVector) const
void	Draw (WsfDraw &aDraw) override
void	DrawRelative (WsfDraw &aDraw, const double aEyePointWCS[3], const double aLookHeading) override
void	DrawCentroid (WsfDraw &aDraw) override
	draw the centroid using WsfDraw in an x
void	DrawBounds (WsfDraw &aDraw) override
	draw the bounding box using WsfDraw
void	DebugDrawZone (WsfDraw &aDraw) override
	draw the zone using WsfDraw
void	DebugDrawZoneRelative (WsfDraw &aDraw, const double aEyePointWCS[3], const double aLookHeading) override
void	DebugDrawCentroid (WsfDraw &aDraw) override
	draw the centroid using WsfDraw in an x
void	DebugDrawBounds (WsfDraw &aDraw) override
	draw the bounding box using WsfDraw
bool	WithinPolygonSides (const double aXorLatValue, const double aYorLonValue) const
Public Member Functions inherited from WsfZone
	WsfZone ()
WsfZone &	operator= (const WsfZone &)=delete
	~WsfZone () override=default
WsfComponent *	CloneComponent () const override
int	GetComponentInitializationOrder () const override
WsfStringId	GetComponentName () const override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
void	ComponentParentChanged (WsfPlatform *aPlatformPtr) override
WsfPlatform *	GetPlatform () const
bool	Initialize (double aSimTime) override
void	SetGlobalName (WsfStringId aGlobalName)
	Set the global model that this zone was cloned from.
WsfStringId	GetGlobalName () const
virtual double	Area ()
virtual WsfGeoPoint	Centroid ()
virtual void	MaxPoint (double &aX, double &aY, double &aAlt)
virtual void	MinPoint (double &aX, double &aY, double &aAlt)
virtual const std::map< WsfStringId, double > &	GetModifierList () const
	Get the modifier list for WsfZoneAttenuation.
virtual double	ModifierValue (const std::string &aModifierName) const
	returns the value of the modifier matching the given name
bool	IsInitialized () const
void	SetFillColor (const std::string &aColor)
void	SetFillColor (const UtColor &aColor)
void	SetLineColor (const std::string &aColor)
void	SetLineColor (const UtColor &aColor)
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)
Public Member Functions inherited from WsfComponentT< WsfPlatform >
	WsfComponentT ()
	WsfComponentT (const WsfComponentT &) noexcept
WsfComponentT &	operator= (const WsfComponentT &) noexcept
	~WsfComponentT () override=default
ParentType *	GetComponentParent () const
void	SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual	~WsfComponent ()=default
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
virtual bool	PreInitialize (double aSimTime)
virtual bool	Initialize2 (double aSimTime)
virtual void	PreInput ()
Public Member Functions inherited from WsfAuxDataEnabled
	WsfAuxDataEnabled ()=default
	WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabled &	operator= (const WsfAuxDataEnabled &aRhs)
	WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabled &	operator= (WsfAuxDataEnabled &&)=default
virtual	~WsfAuxDataEnabled () noexcept
void	SetAuxData (const WsfAttributeContainer &aAuxData)
void	DeleteAuxData ()
	Delete the aux data container from the object.
void	MergeAuxData (const WsfAuxDataEnabled &aSrc)
	Merge the object's aux data with aux data from an existing object.
void	UpdateAuxData (const WsfAuxDataEnabled &aSrc)
	Update the object's aux data with aux data from an existing object.
bool	HasAuxData () const
	Returns true if this object has aux data.
bool	ProcessInput (UtInput &aInput)
template<typename T>
void	Serialize (T &aBuff)
	(De)serialization for XIO
WsfAttributeContainer &	GetAuxData ()
const WsfAttributeContainer &	GetAuxData () const noexcept
const WsfAttributeContainer &	GetAuxDataConst () const noexcept

Protected Member Functions
void	AddPoint (const Point &aPoint)
	WsfZone (const WsfZone &aSrc)
	Copy constructor (for Clone()).
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Additional Inherited Members
Static Public Attributes inherited from WsfZone
static constexpr const char *	cTYPE_KIND = "zone"
static constexpr double	cUNSPECIFIED = 1.0E20
static constexpr double	cHUGE = 9.9E20
static constexpr double	cSMALL = -9.9E20
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
WsfPlatform *	mPlatformPtr
std::map< WsfStringId, double >	mModifierList
double	mMinAlt
double	mMaxAlt
double	mMinX
double	mMaxX
double	mMinY
double	mMaxY
double	mArea
Point	mCentroid
bool	mIsInitialized

Detailed Description

A class for defining a zone.

Member Enumeration Documentation

◆ RelativeToType

enum WsfZoneDefinition::RelativeToType

Enumerator
cOBSERVER	The Zone is relative to the observer (movable to fit the current context).
cINTERNAL	The Zone is fixed at some location or relative to a reference platform.

◆ ShapeType

enum WsfZoneDefinition::ShapeType

Enumerator
cNO_SHAPE	The shape of this Zone has not yet been determined.
cCIRCULAR	The shape of this Zone is a vertical cylinder.
cELLIPTICAL	The shape of this Zone is a vertical extruded ellipse.
cPOLYGONAL	The shape of this Zone is a vertical extruded polygon.
cSPHERICAL	The shape of this Zone is a 3-dimensional sphere.

Constructor & Destructor Documentation

◆ WsfZoneDefinition() [1/2]

WsfZoneDefinition::WsfZoneDefinition ( )

References cNO_SHAPE, cOBSERVER, WsfZone::cUNSPECIFIED, and WsfZone::WsfZone().

Referenced by Clone(), operator=(), ProcessInput(), WsfCodedZone::WsfCodedZone(), and WsfZoneDefinition().

◆ WsfZoneDefinition() [2/2]

WsfZoneDefinition::WsfZoneDefinition ( const WsfZoneDefinition & aSrc )

References WsfZone::WsfZone(), and WsfZoneDefinition().

◆ ~WsfZoneDefinition()

WsfZoneDefinition::~WsfZoneDefinition ( )

overridedefault

References WsfZone::WsfZone().

Member Function Documentation

◆ AddPoint()

void WsfZoneDefinition::AddPoint ( const Point & aPoint )

protected

Add (:at, Lon) the points of a polygonal zone shape.

Parameters

aPoint a point to be added (in clockwise order) of a polyognal zone shape.

Returns: 'void'.

Referenced by WsfCodedZone::ProcessInput(), and WsfCodedZone::WsfCodedZone().

◆ CheckIntersections()

double WsfZoneDefinition::CheckIntersections	(	const double	aLLA1[3],
		const double	aLLA2[3] )

overridevirtual

Reimplemented from WsfZone.

References cSPHERICAL.

◆ Clone()

WsfZone * WsfZoneDefinition::Clone ( ) const

overridevirtual

The standard Clone() method (virtual copy constructor).

Implements WsfZone.

References WsfZone::WsfZone(), and WsfZoneDefinition().

Referenced by UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().

◆ DebugDrawBounds()

void WsfZoneDefinition::DebugDrawBounds ( WsfDraw & aDraw )

overridevirtual

draw the bounding box using WsfDraw

Reimplemented from WsfZone.

References DrawBounds(), WsfDraw::SetColor(), WsfDraw::SetDuration(), and WsfDraw::SetLineSize().

◆ DebugDrawCentroid()

void WsfZoneDefinition::DebugDrawCentroid ( WsfDraw & aDraw )

overridevirtual

draw the centroid using WsfDraw in an x

Reimplemented from WsfZone.

References DrawCentroid(), WsfDraw::SetColor(), WsfDraw::SetDuration(), and WsfDraw::SetLineSize().

◆ DebugDrawZone()

void WsfZoneDefinition::DebugDrawZone ( WsfDraw & aDraw )

overridevirtual

draw the zone using WsfDraw

Reimplemented from WsfZone.

References Draw(), WsfDraw::SetColor(), WsfDraw::SetDuration(), and WsfDraw::SetLineSize().

◆ DebugDrawZoneRelative()

void WsfZoneDefinition::DebugDrawZoneRelative	(	WsfDraw &	aDraw,
		const double	aEyePointWCS[3],
		const double	aLookHeading )

overridevirtual

Reimplemented from WsfZone.

References DrawRelative(), WsfDraw::SetColor(), WsfDraw::SetDuration(), and WsfDraw::SetLineSize().

◆ Draw()

void WsfZoneDefinition::Draw ( WsfDraw & aDraw )

overridevirtual

Draw the zone using WsfDraw

Parameters

aDraw The draw object to be written to

Reimplemented from WsfZone.

References WsfDraw::BeginLines(), cPOLYGONAL, WsfZone::cUNSPECIFIED, WsfDraw::End(), WsfDraw::GetDrawManager(), WsfSimulationExtension::GetSimulation(), WsfZone::mMaxAlt, WsfZone::mMinAlt, UpdateReference(), and WsfDraw::VertexLLA().

Referenced by DebugDrawZone(), and DrawRelative().

◆ DrawBounds()

void WsfZoneDefinition::DrawBounds ( WsfDraw & aDraw )

overridevirtual

draw the bounding box using WsfDraw

Reimplemented from WsfZone.

References WsfDraw::BeginLines(), cPOLYGONAL, WsfDraw::End(), WsfZone::mMaxX, WsfZone::mMaxY, WsfZone::mMinX, WsfZone::mMinY, and WsfDraw::VertexLLA().

Referenced by DebugDrawBounds().

◆ DrawCentroid()

void WsfZoneDefinition::DrawCentroid ( WsfDraw & aDraw )

overridevirtual

draw the centroid using WsfDraw in an x

Reimplemented from WsfZone.

References WsfDraw::BeginLines(), cPOLYGONAL, WsfDraw::End(), WsfZone::mCentroid, and WsfDraw::VertexLLA().

Referenced by DebugDrawCentroid().

◆ DrawRelative()

void WsfZoneDefinition::DrawRelative	(	WsfDraw &	aDraw,
		const double	aEyePointWCS[3],
		const double	aLookHeading )

overridevirtual

Reimplemented from WsfZone.

References WsfDraw::BeginLines(), cINTERNAL, cPOLYGONAL, Draw(), WsfDraw::End(), and WsfDraw::VertexWCS().

Referenced by DebugDrawZoneRelative().

◆ GetAltBounds()

void WsfZoneDefinition::GetAltBounds	(	double &	aMinAlt,
		double &	aMaxAlt ) const

References WsfZone::mMaxAlt, and WsfZone::mMinAlt.

Referenced by ZoneUtils::WithinAltitudeBounds().

◆ GetAngleBounds()

void WsfZoneDefinition::GetAngleBounds	(	double &	aStartAngle,
		double &	aStopAngle ) const

References WsfZone::cUNSPECIFIED.

Referenced by ZoneUtils::GetLatLonPoints(), and ZoneUtils::PointIsInAngularExtents().

◆ GetFillColor()

ut::optional< UtColor > WsfZoneDefinition::GetFillColor ( ) const

overridevirtual

Reimplemented from WsfZone.

References WsfZone::GetFillColor().

◆ GetLatAxisLength()

double WsfZoneDefinition::GetLatAxisLength ( ) const

Referenced by ZoneUtils::GetDistanceFromEllipseToPoint(), and ZoneUtils::GetLatLonPoints().

◆ GetLatLonExtrema()

bool WsfZoneDefinition::GetLatLonExtrema	(	double &	aSouthernLat,
		double &	aWesternLon,
		double &	aNorthernLat,
		double &	aEasternLon ) const

overridevirtual

Returns true if the zone points represent (Lat, Lon), false otherwise. Only if true is returned, argument values represent the lower left and upper right corners of the zone extrema.

Reimplemented from WsfZone.

References cCIRCULAR, cELLIPTICAL, cPOLYGONAL, and cSPHERICAL.

Referenced by ZoneUtils::GetExtraDistanceBasedOnShape().

◆ GetLineColor()

ut::optional< UtColor > WsfZoneDefinition::GetLineColor ( ) const

overridevirtual

Reimplemented from WsfZone.

References WsfZone::GetLineColor().

◆ GetLonAxisLength()

double WsfZoneDefinition::GetLonAxisLength ( ) const

Referenced by ZoneUtils::GetDistanceFromEllipseToPoint(), ZoneUtils::GetExtraDistanceBasedOnShape(), and ZoneUtils::GetLatLonPoints().

◆ GetMinRadius()

double WsfZoneDefinition::GetMinRadius ( ) const

◆ GetPoints() [1/2]

const std::vector< WsfZone::Point > & WsfZoneDefinition::GetPoints ( ) const

inline

Referenced by WsfZoneRouteFinder::AvoidZone(), WsfNavigationMesh::DebugDrawZones(), WsfPathFinder::DebugDrawZones(), WsfPathFinder::FindClosestValidPoint(), WsfNavigationMesh::GetCellZoneInteraction(), ZoneUtils::GetLatLonPoints(), WsfNavigationMesh::ProcessInput(), WsfPathFinder::ProcessInput(), WsfZoneRouteFinder::RouteAroundZones(), UT_DEFINE_SCRIPT_METHOD(), and VerticesIn().

◆ GetPoints() [2/2]

void WsfZoneDefinition::GetPoints ( std::vector< WsfGeoPoint > & aPoints ) const

returns an array of geopoints that make up the vertices of the zone ***** currently doesn't support altitude

◆ GetRadius()

double WsfZoneDefinition::GetRadius ( ) const

Referenced by ZoneUtils::GetClosestPointInZone(), ZoneUtils::GetDistanceFromPointToZone(), ZoneUtils::GetExtraDistanceBasedOnShape(), and ZoneUtils::GetLatLonPoints().

◆ GetReferenceHeading()

double WsfZoneDefinition::GetReferenceHeading ( ) const

Referenced by ZoneUtils::GetClosestPointInZone(), ZoneUtils::GetDistanceFromEllipseToPoint(), ZoneUtils::GetDistanceFromPointToZone(), ZoneUtils::GetLatLonPoints(), and ZoneUtils::PointIsInAngularExtents().

◆ GetReferenceLat()

double WsfZoneDefinition::GetReferenceLat ( ) const

inline

◆ GetReferenceLon()

double WsfZoneDefinition::GetReferenceLon ( ) const

inline

◆ GetReferencePlatform()

WsfPlatform * WsfZoneDefinition::GetReferencePlatform ( WsfSimulation * aSimulationPtr ) const

References WsfSimulation::GetPlatformByIndex(), WsfSimulation::GetPlatformByName(), and platformPtr.

Referenced by ZoneUtils::RecalcCentroid().

◆ GetReferencePlatformName()

WsfStringId WsfZoneDefinition::GetReferencePlatformName ( ) const

inline

◆ GetRelativeType()

RelativeToType WsfZoneDefinition::GetRelativeType ( ) const

inline

Referenced by WsfZoneRouteFinder::AvoidZone(), ZoneUtils::GetDistanceFromPointToZone(), ZoneUtils::GetDistanceFromPointToZoneCenter(), ZoneUtils::GetLatLonPoints(), ZoneUtils::GetZoneCentroid(), ZoneUtils::isProjectedInsideZone2Points(), ZoneUtils::isProjectedInsideZonePointHeading(), ZoneUtils::isProjectedInsideZonePosVel(), UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().

◆ GetShapeType()

ShapeType WsfZoneDefinition::GetShapeType ( ) const

inline

Referenced by WsfZoneRouteFinder::AvoidZone(), ZoneUtils::GetClosestPointInZone(), ZoneUtils::GetDistanceFromEllipseToPoint(), ZoneUtils::GetDistanceFromPointToZone(), ZoneUtils::GetExtraDistanceBasedOnShape(), ZoneUtils::GetLatLonPoints(), ZoneUtils::GetZoneCentroid(), and UT_DEFINE_SCRIPT_METHOD().

◆ HasAbsoluteLatLon()

bool WsfZoneDefinition::HasAbsoluteLatLon ( ) const

inline

◆ Initialize()

void WsfZoneDefinition::Initialize ( const WsfScenario & aScenario )

overridevirtual

Initializes and validates the attributes of the zone shape.

Returns: 'true' if initialization successful.

Reimplemented from WsfZone.

References cINTERNAL, cNO_SHAPE, cPOLYGONAL, WsfZone::cUNSPECIFIED, WsfObject::GetName(), WsfZone::mIsInitialized, WsfZone::mMaxAlt, WsfZone::mMaxX, WsfZone::mMaxY, WsfZone::mMinAlt, WsfZone::mMinX, WsfZone::mMinY, WsfZone::mModifierList, and ok.

◆ IsNegative()

bool WsfZoneDefinition::IsNegative ( ) const

inline

Returns true the zone is a 'negative' zone and returns the opposite value for PointIsInside().

◆ operator=()

WsfZoneDefinition & WsfZoneDefinition::operator= ( const WsfZoneDefinition & )

delete

References WsfZoneDefinition().

◆ PointIsInside()

bool WsfZoneDefinition::PointIsInside	(	WsfSimulation *	aSimulationPtr,
		const double	aViewedPointWCS[3],
		const double	aEyePointWCS[3],
		const double	aLookHeading,
		const double	aDeltaDownRange = 0.0 )

overridevirtual

Is the point inside the zone?

Parameters

aSimulationPtr	the simulation
aViewedPointWCS	the point which is being tested for containment in the zone.
aEyePointWCS	is the potential reference point for a relative Zone.
aLookHeading	the current heading (for relative references)
aDeltaDownRange	is an (optional) delta to slide the Zone away from the eyepoint. (Used to adjust the Zone location for off-design conditions.)

Returns: 'true' if the point is inside the Zone or 'false' otherwise.

Reimplemented from WsfZone.

References WsfSimulation::GetPlatformByIndex(), WsfSimulation::GetPlatformByName(), platformPtr, and SetReference().

Referenced by WsfPathFinder::FindClosestValidPoint(), WsfNavigationMesh::GetCellZoneInteraction(), ZoneUtils::GetClosestPointInZone(), ZoneUtils::GetDistanceFromPointToZone(), ZoneUtils::isProjectedInsideZone2Points(), and UT_DEFINE_SCRIPT_METHOD().

◆ PointsAreLatLon()

bool WsfZoneDefinition::PointsAreLatLon ( )

inline

Referenced by WsfZoneRouteFinder::AvoidZone().

◆ ProcessInput()

bool WsfZoneDefinition::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfZone.

References cCIRCULAR, cELLIPTICAL, cINTERNAL, cNO_SHAPE, cPOLYGONAL, cSPHERICAL, WsfZone::cUNSPECIFIED, WsfScenario::FindType(), WsfScenario::FromInput(), WsfZone::mMaxAlt, WsfZone::mMinAlt, WsfZone::mModifierList, WsfZone::ProcessInput(), success, and WsfZoneDefinition().

◆ Reference()

WsfGeoPoint WsfZoneDefinition::Reference ( )

overridevirtual

return the geopoint of the reference point

Implements WsfZone.

Referenced by ZoneUtils::GetZoneCentroid(), and UT_DEFINE_SCRIPT_METHOD().

◆ SetAltBounds()

void WsfZoneDefinition::SetAltBounds	(	double	aMinAlt,
		double	aMaxAlt )

Set the altitude bounds of the zone shape.

Parameters

aMinAlt	the minimum altitude limit of the zone shape.
aMaxAlt	the maximum altitude limit of the zone shape.

Returns: 'void'.

References WsfZone::cUNSPECIFIED, WsfZone::mIsInitialized, WsfZone::mMaxAlt, and WsfZone::mMinAlt.

◆ SetAngleBounds()

void WsfZoneDefinition::SetAngleBounds	(	double	aStartAngle,
		double	aStopAngle )

Set the radial angle bounds of the zone shape.

Parameters

aStartAngle	the minimum radial angle limit of the zone shape.
aStopAngle	the maximum radial angle limit of the zone shape.

Returns: 'void'.

References WsfZone::cUNSPECIFIED, and WsfZone::mIsInitialized.

◆ SetEllipticalAxes()

void WsfZoneDefinition::SetEllipticalAxes	(	double	aLatAxisLen,
		double	aLonAxisLen )

Set the elliptical axes of the zone shape.

Parameters

aLatAxisLen	the latitude axis of an elliptical zone shape.
aLonAxisLen	the longitude axis of an elliptical zone shape.

Returns: 'void'.

References WsfZone::mIsInitialized.

◆ SetPointsAreLatLon()

void WsfZoneDefinition::SetPointsAreLatLon ( bool aValue )

inline

Referenced by WsfCodedZone::ProcessInput(), and WsfCodedZone::WsfCodedZone().

◆ SetPolyPoints()

void WsfZoneDefinition::SetPolyPoints ( const std::vector< WsfGeoPoint > & aPoints )

Set the points / vertices of a polygonal zone shape.

Parameters

aPoints the points (in clockwise order) of a polyognal zone shape.

Returns: 'void'.

References WsfZone::cHUGE, cINTERNAL, cPOLYGONAL, WsfZone::cSMALL, WsfZone::cUNSPECIFIED, WsfZone::mIsInitialized, WsfZone::mMaxX, WsfZone::mMaxY, WsfZone::mMinX, and WsfZone::mMinY.

Referenced by UT_DEFINE_SCRIPT_METHOD().

◆ SetPolyPointsRelative()

void WsfZoneDefinition::SetPolyPointsRelative ( const std::vector< UtVec3d > & aPoints )

References WsfZone::cHUGE, cOBSERVER, WsfZone::cSMALL, WsfZone::mIsInitialized, WsfZone::mMaxX, WsfZone::mMaxY, WsfZone::mMinX, and WsfZone::mMinY.

◆ SetRadialBounds()

void WsfZoneDefinition::SetRadialBounds	(	double	aMinRadius,
		double	aMaxRadius )

Set the radial range bounds of the zone shape.

Parameters

aMinRadius	the minimum radial range limit of the zone shape.
aMaxRadius	the maximum radial range limit of the zone shape.

Returns: 'void'.

References WsfZone::cUNSPECIFIED, and WsfZone::mIsInitialized.

Referenced by WsfZoneReference::Initialize().

◆ SetReference() [1/4]

void WsfZoneDefinition::SetReference	(	const WsfGeoPoint &	aReference,
		double	aReferenceHeading )

Set the geometric reference point for the zone.

Set the geometric reference point for the zone. (There are 4 different forms of the same method.)

Parameters

aReference	the geopoint where the zone will be placed.
aReferenceHeading	the new heading at which the zone will be oriented.

Returns: 'void'.

References cINTERNAL, WsfGeoPoint::GetLat(), WsfGeoPoint::GetLon(), and SetReference().

◆ SetReference() [2/4]

void WsfZoneDefinition::SetReference	(	double	aReferenceLat,
		double	aReferenceLon,
		double	aReferenceHeading )

Set the geodetic reference point for the zone.

Set the geometric reference point for the zone. (There are 4 different forms of the same method.)

Parameters

aReferenceLat	the latitude at which the zone will be placed.
aReferenceLon	the longitude at which the zone will be placed.
aReferenceHeading	the new heading at which the zone will be oriented.

Returns: 'void'.

References cINTERNAL, and SetReference().

◆ SetReference() [3/4]

void WsfZoneDefinition::SetReference	(	double	aReferenceWCS[3],
		double	aReferenceHeading )

Set the geometric reference point for the zone.

Set the geometric reference point for the zone. (There are 4 different forms of the same method.)

Parameters

aReferenceWCS	the world coordinates where the zone will be placed.
aReferenceHeading	the new heading at which the zone will be oriented.

Returns: 'void'.

References cINTERNAL, and SetReference().

◆ SetReference() [4/4]

void WsfZoneDefinition::SetReference ( UtEntity & aReference )

Set the geometric reference point for the zone.

Set the geometric reference point for the zone. (There are 4 different forms of the same method.)

Parameters

aReference the UtEntity at a location where the zone will be placed.

Returns: 'void'.

References cINTERNAL, and SetReference().

Referenced by PointIsInside(), SetReference(), SetReference(), SetReference(), SetReference(), and UpdateReference().

◆ SetRelativeType()

void WsfZoneDefinition::SetRelativeType ( RelativeToType aType )

Set the relative type of the zone, which specifies it's relative or fixed location.

Parameters

aType the new enumerated relative type of the zone.

Returns: 'void'.

References WsfZone::mIsInitialized.

◆ SetShapeType()

void WsfZoneDefinition::SetShapeType ( ShapeType aType )

Set the shape type of the zone.

Parameters

aType the new enumerated shape type of the zone.

Returns: 'void'.

References WsfZone::mIsInitialized.

Referenced by WsfZoneReference::Initialize(), WsfCodedZone::ProcessInput(), and WsfCodedZone::WsfCodedZone().

◆ UpdateReference()

void WsfZoneDefinition::UpdateReference ( const WsfSimulation & aSimulation )

Update the geometric reference point for the zone from the simulation.

Update the relevant reference platform for the zone from the simulation.

Parameters

aSimulation A reference to the simulation object.

Returns: 'void'.

References WsfZone::cUNSPECIFIED, WsfSimulation::GetPlatformByIndex(), WsfSimulation::GetPlatformByName(), platformPtr, and SetReference().

Referenced by Draw(), and UT_DEFINE_SCRIPT_METHOD().

◆ VerticesIn()

void WsfZoneDefinition::VerticesIn	(	double	aMinX,
		double	aMinY,
		double	aMaxX,
		double	aMaxY,
		std::vector< Point > &	aPointsVector ) const

References GetPoints().

◆ WithinPolygonSides()

bool WsfZoneDefinition::WithinPolygonSides	(	const double	aXorLatValue,
		const double	aYorLonValue ) const

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ RelativeToType

◆ ShapeType

Constructor & Destructor Documentation

◆ WsfZoneDefinition() [1/2]

◆ WsfZoneDefinition() [2/2]

◆ ~WsfZoneDefinition()

Member Function Documentation

◆ AddPoint()

◆ CheckIntersections()

◆ Clone()

◆ DebugDrawBounds()

◆ DebugDrawCentroid()

◆ DebugDrawZone()

◆ DebugDrawZoneRelative()

◆ Draw()

◆ DrawBounds()

◆ DrawCentroid()

◆ DrawRelative()

◆ GetAltBounds()

◆ GetAngleBounds()

◆ GetFillColor()

◆ GetLatAxisLength()

◆ GetLatLonExtrema()

◆ GetLineColor()

◆ GetLonAxisLength()

◆ GetMinRadius()

◆ GetPoints() [1/2]

◆ GetPoints() [2/2]

◆ GetRadius()

◆ GetReferenceHeading()

◆ GetReferenceLat()

◆ GetReferenceLon()

◆ GetReferencePlatform()

◆ GetReferencePlatformName()

◆ GetRelativeType()

◆ GetShapeType()

◆ HasAbsoluteLatLon()

◆ Initialize()

◆ IsNegative()

◆ operator=()

◆ PointIsInside()

◆ PointsAreLatLon()

◆ ProcessInput()

◆ Reference()

◆ SetAltBounds()

◆ SetAngleBounds()

◆ SetEllipticalAxes()

◆ SetPointsAreLatLon()

◆ SetPolyPoints()

◆ SetPolyPointsRelative()

◆ SetRadialBounds()

◆ SetReference() [1/4]

◆ SetReference() [2/4]

◆ SetReference() [3/4]

◆ SetReference() [4/4]

◆ SetRelativeType()

◆ SetShapeType()

◆ UpdateReference()

◆ VerticesIn()

◆ WithinPolygonSides()