Geometry Class

Definition

Namespace:Avalonia.Media

Assembly:Avalonia.Base

Package:Avalonia

Source:Geometry.cs

Defines a geometric shape.

public class Geometry

Inheritance: object -> AvaloniaObject -> Geometry

Derived types: CombinedGeometry, EllipseGeometry, GeometryGroup, LineGeometry, PolylineGeometry, RectangleGeometry, StreamGeometry

Implements: ICompositionRenderResource, ICompositionRenderResource<ServerCompositionSimpleGeometry>, ICompositorSerializable

Methods

Name	Description
Bind (8 overloads)	Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject.
CheckAccess	Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject.
ClearValue (4 overloads)	Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject.
Clone	Clones the geometry.
CoerceValue	Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
Combine	Combines the two geometries using the specified Avalonia.Media.GeometryCombineMode and applies the specified transform to the resulting geometry.
Equals	Compares two objects using reference equality. Inherited from AvaloniaObject.
FillContains	Indicates whether the geometry's fill contains the specified point.
GetBaseValue	Inherited from AvaloniaObject.
GetHashCode	Gets the hash code for the object. Inherited from AvaloniaObject.
GetRenderBounds	Gets the geometry's bounding rectangle with the specified pen.
GetValue (3 overloads)	Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
GetWidenedGeometry	Gets a Avalonia.Media.Geometry that is the shape defined by the stroke on the Geometry produced by the specified Pen.
IsAnimating	Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSet	Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
Parse	Creates a Avalonia.Media.Geometry from a string.
SetCurrentValue (2 overloads)	Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetValue (3 overloads)	Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
StrokeContains	Indicates whether the geometry's stroke contains the specified point.
TryGetPointAndTangentAtDistance	No summary available.
TryGetPointAtDistance	No summary available.
TryGetSegment	No summary available.
VerifyAccess	Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

Clone Method

Clones the geometry.

public Avalonia.Media.Geometry Clone()

Returns

Avalonia.Media.Geometry

A cloned geometry.

Combine Method

Combines the two geometries using the specified Avalonia.Media.GeometryCombineMode and applies the specified transform to the resulting geometry.

public Avalonia.Media.Geometry Combine(Avalonia.Media.Geometry geometry1, Avalonia.Media.RectangleGeometry geometry2, Avalonia.Media.GeometryCombineMode combineMode, Avalonia.Media.Transform transform)

Parameters

geometry1 Avalonia.Media.Geometry

The first geometry to combine.

geometry2 Avalonia.Media.RectangleGeometry

The second geometry to combine.

combineMode Avalonia.Media.GeometryCombineMode

One of the enumeration values that specifies how the geometries are combined.

transform Avalonia.Media.Transform

A transformation to apply to the combined geometry, or null.

Returns

Avalonia.Media.Geometry

FillContains Method

Indicates whether the geometry's fill contains the specified point.

public bool FillContains(Avalonia.Point point)

Parameters

point Avalonia.Point

The point.

Returns

bool

true if the geometry contains the point; otherwise, false.

GetRenderBounds Method

Gets the geometry's bounding rectangle with the specified pen.

public Avalonia.Rect GetRenderBounds(Avalonia.Media.IPen pen)

Parameters

pen Avalonia.Media.IPen

The stroke thickness.

Returns

Avalonia.Rect

The bounding rectangle.

GetWidenedGeometry Method

Gets a Avalonia.Media.Geometry that is the shape defined by the stroke on the Geometry produced by the specified Pen.

public Avalonia.Media.Geometry GetWidenedGeometry(Avalonia.Media.IPen pen)

Parameters

pen Avalonia.Media.IPen

The pen to use.

Returns

Avalonia.Media.Geometry

The outlined geometry.

Parse Method

Creates a Avalonia.Media.Geometry from a string.

public Avalonia.Media.Geometry Parse(string s)

Parameters

s string

The string.

Returns

Avalonia.Media.Geometry

A Avalonia.Media.StreamGeometry.

StrokeContains Method

Indicates whether the geometry's stroke contains the specified point.

public bool StrokeContains(Avalonia.Media.IPen pen, Avalonia.Point point)

Parameters

pen Avalonia.Media.IPen

The pen to use.

point Avalonia.Point

The point.

Returns

bool

true if the geometry contains the point; otherwise, false.

TryGetPointAndTangentAtDistance Method

public bool TryGetPointAndTangentAtDistance(double distance, Avalonia.Point& point, Avalonia.Point& tangent)

Parameters

distance double

point Avalonia.Point&

tangent Avalonia.Point&

Returns

bool

TryGetPointAtDistance Method

public bool TryGetPointAtDistance(double distance, Avalonia.Point& point)

Parameters

distance double

point Avalonia.Point&

Returns

bool

TryGetSegment Method

public bool TryGetSegment(double startDistance, double stopDistance, bool startOnBeginFigure, Avalonia.Media.Geometry& segmentGeometry)

Parameters

startDistance double

stopDistance double

startOnBeginFigure bool

segmentGeometry Avalonia.Media.Geometry&

Returns

bool

Properties

Name	Description
Bounds	Gets the geometry's bounding rectangle.
ContourLength	Gets the geometry's total length as if all its contours are placed in a straight line.
Dispatcher	Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
Item	Inherited from AvaloniaObject.
Transform	Gets or sets a transform to apply to the geometry.

Bounds Property

Gets the geometry's bounding rectangle.

public Avalonia.Rect Bounds { get; set; }

ContourLength Property

Gets the geometry's total length as if all its contours are placed in a straight line.

public double ContourLength { get; set; }

Transform Property

Gets or sets a transform to apply to the geometry.

public Avalonia.Media.Transform Transform { get; set; }

Fields

Name	Description
TransformProperty	Defines the Avalonia.Media.Geometry.Transform property.

TransformProperty Field

Defines the Avalonia.Media.Geometry.Transform property.

public Avalonia.StyledProperty<TValue><Avalonia.Media.Transform> TransformProperty

Events

Name	Description
Changed	Raised when the geometry changes.
PropertyChanged	Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.

Changed Event

Raised when the geometry changes.

public event EventHandler Changed