TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.ISimpleDrawObject Interface Reference

Inheritance diagram for TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.ISimpleDrawObject:

Public Member Functions
double	GetArea ()
	Get the area of the simple draw object.
double	GetLength ()
	Get the length/circumference of the simple draw object.

Properties
ItemId	Id [get, set]
bool	IsDynamic [get, set]
	Get or set if the object is frequently changing.
IDataFields	DataFields [get, set]
	Common draw object data fields, such as Name and Draw depth. These fields are always set, regardless of whether or not the object is tactical or generic.
IGenericDataFields	GenericDataFields [get]
	Generic data fields. Data fields related to generic draw objects. These will only be non-zero if we have a generic draw object.
ITacticalDataFields	TacticalDataFields [get]
	Tactical data fields. Data fields related to tactical draw objects. These will only be non-zero if we have a tactical draw object.
GeoPoint[]	Points [get, set]
	Geometry points. These points make up the geometric data of the draw object and may have different uses based on what the derived object type is. For an IPolygonArea this will be the boundary of the object. For an ICorridorArea these points will be the center line.
List< ISimpleDrawObject >	CompositeDrawObjects [get]

Member Function Documentation

GetArea()

double TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.ISimpleDrawObject.GetArea

(

)

Get the area of the simple draw object.

Returns

Area in square meters.

Implemented in TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.CorridorArea, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.Ellipse, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.FanArea, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.PolygonArea, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolCorridorArea, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolEllipse, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolFanArea, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolPolyArea, and TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.SimpleDrawObject.

GetLength()

double TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.ISimpleDrawObject.GetLength

(

)

Get the length/circumference of the simple draw object.

Returns

Length/Circumference in meters.

Implemented in TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.CorridorArea, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.Ellipse, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.FanArea, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.Line, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.PolygonArea, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.RouteArea, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolCorridorArea, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolEllipse, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolFanArea, TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolPolyArea, and TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.SimpleDrawObject.

Property Documentation

CompositeDrawObjects

List<ISimpleDrawObject> TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.ISimpleDrawObject.CompositeDrawObjects

get

Implemented in TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.SimpleDrawObject.

DataFields

IDataFields TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.ISimpleDrawObject.DataFields

getset

Common draw object data fields, such as Name and Draw depth. These fields are always set, regardless of whether or not the object is tactical or generic.

Implemented in TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.SimpleDrawObject.

GenericDataFields

IGenericDataFields TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.ISimpleDrawObject.GenericDataFields

get

Generic data fields. Data fields related to generic draw objects. These will only be non-zero if we have a generic draw object.

Implemented in TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.SimpleDrawObject.

Id

ItemId TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.ISimpleDrawObject.Id

getset

Implemented in TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.SimpleDrawObject.

IsDynamic

bool TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.ISimpleDrawObject.IsDynamic

getset

Get or set if the object is frequently changing.

Implemented in TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.SimpleDrawObject.

Points

GeoPoint [] TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.ISimpleDrawObject.Points

getset

Geometry points. These points make up the geometric data of the draw object and may have different uses based on what the derived object type is. For an IPolygonArea this will be the boundary of the object. For an ICorridorArea these points will be the center line.

Implemented in TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.SimpleDrawObject.

TacticalDataFields

ITacticalDataFields TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.ISimpleDrawObject.TacticalDataFields

get

Tactical data fields. Data fields related to tactical draw objects. These will only be non-zero if we have a tactical draw object.

Implemented in TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.SimpleDrawObject.

---

The documentation for this interface was generated from the following file:

• Src/Components/DrawObjectsNG/TPG.DrawObjects.Contracts/SimpleDrawObjectAPI/ISimpleDrawObject.cs