A volume fan area is a volume with a surface in the form of a truncated ring sector. It is defined by a centre point, a sector angle, innner and outer radii. More...

Inheritance diagram for TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolFanArea:

Public Member Functions
override double	GetArea ()
	Get the area of the simple draw object. Returns Area in square meters.

override double	GetLength ()
	Get the length/circumference of the simple draw object. Returns Length/Circumference in meters.

virtual double	GetArea ()
	Get the area of the simple draw object. Returns Area in square meters.

virtual double	GetLength ()
	Get the length/circumference of the simple draw object. Returns Length/Circumference in meters.

double	GetArea ()
	Get the area of the simple draw object.

double	GetLength ()
	Get the length/circumference of the simple draw object.

Properties
double	MinimumRange `[get, set]`
	Distance from the center point to the inner ring sector.

double	MaximumRange `[get, set]`
	Distance from the center point to the outer ring sector.

float	OrientationAngle `[get, set]`
	Rotational angle in degrees clockwise between the line of true north and the left side of the sector.

float	SectorSizeAngle `[get, set]`
	Rotational angle in degrees clockwise between the left and right sides of the sector (opening angle).

GeoPoint	VertexPoint `[get, set]`
	Central point of the sector.

IVerticalDistanceData	LowerVerticalDistance `[get, set]`
	Lower vertical distance /summary>summary> Upper vertical distance /summary>

IVerticalDistanceData	UpperVerticalDistance `[get, set]`

Properties inherited from TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.SimpleDrawObject
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, set]`

int	DrawObjectVersion = 1 `[get, set]`

Properties inherited from TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.ISimpleDrawObject
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]`

Properties inherited from TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.ISimpleDrawObjectVersionInfo
int	DrawObjectVersion `[get, set]`

Properties inherited from TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.Primitives.IFanArea
double	MinimumRange `[get, set]`
	Distance from the center point to the inner ring sector.

double	MaximumRange `[get, set]`
	Distance from the center point to the outer ring sector.

float	OrientationAngle `[get, set]`
	Rotational angle in degrees clockwise between the line of true north and the left side of the sector.

float	SectorSizeAngle `[get, set]`
	Rotational angle in degrees clockwise between the left and right sides of the sector (opening angle).

GeoPoint	VertexPoint `[get, set]`
	Central point of the sector.

Properties inherited from TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.Primitives.ISurfaceVolume
IVerticalDistanceData	LowerVerticalDistance `[get, set]`
	Lower vertical distance /summary>

IVerticalDistanceData	UpperVerticalDistance `[get, set]`

Detailed Description

A volume fan area is a volume with a surface in the form of a truncated ring sector. It is defined by a centre point, a sector angle, innner and outer radii.

Member Function Documentation

◆ GetArea()

override double TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolFanArea.GetArea ( )

inlinevirtual

Get the area of the simple draw object.

Returns: Area in square meters.

Reimplemented from TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.SimpleDrawObject.

◆ GetLength()

override double TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolFanArea.GetLength ( )

inlinevirtual

Get the length/circumference of the simple draw object.

Returns: Length/Circumference in meters.

Reimplemented from TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.SimpleDrawObject.

Property Documentation

◆ LowerVerticalDistance

IVerticalDistanceData TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolFanArea.LowerVerticalDistance

getset

Lower vertical distance /summary>summary> Upper vertical distance /summary>

Implements TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.Primitives.ISurfaceVolume.

◆ MaximumRange

double TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolFanArea.MaximumRange

getset

Distance from the center point to the outer ring sector.

Implements TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.Primitives.IFanArea.

◆ MinimumRange

double TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolFanArea.MinimumRange

getset

Distance from the center point to the inner ring sector.

Implements TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.Primitives.IFanArea.

◆ OrientationAngle

float TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolFanArea.OrientationAngle

getset

Rotational angle in degrees clockwise between the line of true north and the left side of the sector.

Implements TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.Primitives.IFanArea.

◆ SectorSizeAngle

float TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolFanArea.SectorSizeAngle

getset

Rotational angle in degrees clockwise between the left and right sides of the sector (opening angle).

Implements TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.Primitives.IFanArea.

◆ UpperVerticalDistance

IVerticalDistanceData TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolFanArea.UpperVerticalDistance

getset

Implements TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.Primitives.ISurfaceVolume.

◆ VertexPoint

GeoPoint TPG.DrawObjects.ClientUtils.SimpleDrawObjectAPI.Primitives.VolFanArea.VertexPoint

getset

Central point of the sector.

Implements TPG.DrawObjects.Contracts.SimpleDrawObjectAPI.Primitives.IFanArea.

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

Src/Components/DrawObjectsNG/TPG.DrawObjects.ClientUtils/SimpleDrawObjectAPI/Primitives/VolFanArea.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ GetArea()

◆ GetLength()

Property Documentation

◆ LowerVerticalDistance

◆ MaximumRange

◆ MinimumRange

◆ OrientationAngle

◆ SectorSizeAngle

◆ UpperVerticalDistance

◆ VertexPoint