LuciadCPillar C# 2023.1.04
Luciad.Drawing.RelativePosition Struct Reference

Describes a position relative to an anchor, with a rotation, alignment and offset. More...

Inheritance diagram for Luciad.Drawing.RelativePosition:

Public Member Functions

 RelativePosition (Angle rotation, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment, double offsetX, double offsetY)
 Creates a new RelativePosition with the given values. More...
 
 RelativePosition (RelativePosition other)
 
override bool Equals (object other)
 
bool Equals (RelativePosition other)
 
override int GetHashCode ()
 

Static Public Member Functions

static RelativePosition Center ()
 Returns a RelativePosition located on the anchor point with no offset. More...
 
static RelativePosition East (double offset)
 Returns a RelativePosition located to the east of the anchor point with the given offset. More...
 
static RelativePosition North (double offset)
 Returns a RelativePosition located to the north of the anchor point with the given offset. More...
 
static RelativePosition NorthEast (double offsetNorth, double offsetEast)
 Returns a RelativePosition located to the north-east of the anchor point with the given offsets. More...
 
static RelativePosition NorthWest (double offsetNorth, double offsetWest)
 Returns a RelativePosition located to the north-west of the anchor point with the given offsets. More...
 
static bool operator!= (RelativePosition lhs, RelativePosition rhs)
 
static bool operator== (RelativePosition lhs, RelativePosition rhs)
 
static RelativePosition South (double offset)
 Returns a RelativePosition located to the south of the anchor point with the given offset. More...
 
static RelativePosition SouthEast (double offsetSouth, double offsetEast)
 Returns a RelativePosition located to the south-east of the anchor point with the given offsets. More...
 
static RelativePosition SouthWest (double offsetSouth, double offsetWest)
 Returns a RelativePosition located to the south-west of the anchor point with the given offsets. More...
 
static RelativePosition West (double offset)
 Returns a RelativePosition located to the west of the anchor point with the given offset. More...
 

Properties

HorizontalAlignment HorizontalAlignment [get]
 
double OffsetX [get]
 
double OffsetY [get]
 
Angle Rotation [get]
 
VerticalAlignment VerticalAlignment [get]
 

Detailed Description

Describes a position relative to an anchor, with a rotation, alignment and offset.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RelativePosition.

Constructor & Destructor Documentation

◆ RelativePosition() [1/2]

Luciad.Drawing.RelativePosition.RelativePosition ( Angle  rotation,
HorizontalAlignment  horizontalAlignment,
VerticalAlignment  verticalAlignment,
double  offsetX,
double  offsetY 
)
inline

Creates a new RelativePosition with the given values.

rotation

the rotation around the anchor point.

horizontalAlignment

the horizontal alignment of this RelativePosition.

verticalAlignment

the vertical alignment of this RelativePosition.

offsetX

the horizontal offset, expressed in pixels and relative to the anchor point.

offsetY

the vertical offset, expressed in pixels and relative to the anchor point.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RelativePosition::RelativePosition.

◆ RelativePosition() [2/2]

Luciad.Drawing.RelativePosition.RelativePosition ( RelativePosition  other)
inline

Member Function Documentation

◆ Center()

Luciad.Drawing.RelativePosition Luciad.Drawing.RelativePosition.Center ( )
inlinestatic

Returns a RelativePosition located on the anchor point with no offset.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RelativePosition::center.

◆ East()

Luciad.Drawing.RelativePosition Luciad.Drawing.RelativePosition.East ( double  offset)
inlinestatic

Returns a RelativePosition located to the east of the anchor point with the given offset.

offset

: the horizontal offset, expressed in pixels and relative to the anchor point.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RelativePosition::east.

◆ Equals() [1/2]

override bool Luciad.Drawing.RelativePosition.Equals ( object  other)
inline

◆ Equals() [2/2]

bool Luciad.Drawing.RelativePosition.Equals ( RelativePosition  other)
inline

◆ GetHashCode()

override int Luciad.Drawing.RelativePosition.GetHashCode ( )
inline

◆ North()

Luciad.Drawing.RelativePosition Luciad.Drawing.RelativePosition.North ( double  offset)
inlinestatic

Returns a RelativePosition located to the north of the anchor point with the given offset.

offset

: the vertical offset, expressed in pixels and relative to the anchor point.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RelativePosition::north.

◆ NorthEast()

Luciad.Drawing.RelativePosition Luciad.Drawing.RelativePosition.NorthEast ( double  offsetNorth,
double  offsetEast 
)
inlinestatic

Returns a RelativePosition located to the north-east of the anchor point with the given offsets.

offsetNorth

: the vertical offset, expressed in pixels and relative to the anchor point.

offsetEast

: the horizontal offset, expressed in pixels and relative to the anchor point.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RelativePosition::northEast.

◆ NorthWest()

Luciad.Drawing.RelativePosition Luciad.Drawing.RelativePosition.NorthWest ( double  offsetNorth,
double  offsetWest 
)
inlinestatic

Returns a RelativePosition located to the north-west of the anchor point with the given offsets.

offsetNorth

: the vertical offset, expressed in pixels and relative to the anchor point.

offsetWest

: the horizontal offset, expressed in pixels and relative to the anchor point.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RelativePosition::northWest.

◆ operator!=()

static bool Luciad.Drawing.RelativePosition.operator!= ( RelativePosition  lhs,
RelativePosition  rhs 
)
inlinestatic

◆ operator==()

static bool Luciad.Drawing.RelativePosition.operator== ( RelativePosition  lhs,
RelativePosition  rhs 
)
inlinestatic

◆ South()

Luciad.Drawing.RelativePosition Luciad.Drawing.RelativePosition.South ( double  offset)
inlinestatic

Returns a RelativePosition located to the south of the anchor point with the given offset.

offset

: the vertical offset, expressed in pixels and relative to the anchor point.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RelativePosition::south.

◆ SouthEast()

Luciad.Drawing.RelativePosition Luciad.Drawing.RelativePosition.SouthEast ( double  offsetSouth,
double  offsetEast 
)
inlinestatic

Returns a RelativePosition located to the south-east of the anchor point with the given offsets.

offsetSouth

: the vertical offset, expressed in pixels and relative to the anchor point.

offsetEast

: the horizontal offset, expressed in pixels and relative to the anchor point.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RelativePosition::southEast.

◆ SouthWest()

Luciad.Drawing.RelativePosition Luciad.Drawing.RelativePosition.SouthWest ( double  offsetSouth,
double  offsetWest 
)
inlinestatic

Returns a RelativePosition located to the south-west of the anchor point with the given offsets.

offsetSouth

: the vertical offset, expressed in pixels and relative to the anchor point.

offsetWest

: the horizontal offset, expressed in pixels and relative to the anchor point.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RelativePosition::southWest.

◆ West()

Luciad.Drawing.RelativePosition Luciad.Drawing.RelativePosition.West ( double  offset)
inlinestatic

Returns a RelativePosition located to the west of the anchor point with the given offset.

offset

: the horizontal offset, expressed in pixels and relative to the anchor point.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RelativePosition::west.

Property Documentation

◆ HorizontalAlignment

HorizontalAlignment Luciad.Drawing.RelativePosition.HorizontalAlignment
get

◆ OffsetX

double Luciad.Drawing.RelativePosition.OffsetX
get

◆ OffsetY

double Luciad.Drawing.RelativePosition.OffsetY
get

◆ Rotation

Angle Luciad.Drawing.RelativePosition.Rotation
get

◆ VerticalAlignment

VerticalAlignment Luciad.Drawing.RelativePosition.VerticalAlignment
get