Export (0) Print
Expand All

CombinedGeometry Class

Represents a 2-D geometric shape defined by the combination of two Geometry objects.

Namespace:  System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

public sealed class CombinedGeometry : Geometry
<CombinedGeometry .../>

The CombinedGeometry type exposes the following members.

  NameDescription
Public methodCombinedGeometry() Initializes a new instance of the CombinedGeometry class.
Public methodCombinedGeometry(Geometry, Geometry) Initializes a new instance of the CombinedGeometry class with the specified Geometry objects.
Public methodCombinedGeometry(GeometryCombineMode, Geometry, Geometry)Initializes a new instance of the CombinedGeometry class with the specified Geometry objects and GeometryCombineMode.
Public methodCombinedGeometry(GeometryCombineMode, Geometry, Geometry, Transform)Initializes a new instance of the CombinedGeometry class with the specified Geometry objects, GeometryCombineMode, and Transform.
Top

  NameDescription
Public propertyBounds Gets a Rect that specifies the bounding box of this CombinedGeometry object. Note: This method does not take any pens into account. (Overrides Geometry.Bounds.)
Public propertyCanFreezeGets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
Public propertyDependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertyGeometry1 Gets or sets the first Geometry object of this CombinedGeometry object.
Public propertyGeometry2 Gets or sets the second Geometry object of this CombinedGeometry object.
Public propertyGeometryCombineModeGets or sets the method by which the two geometries (specified by the Geometry1 and Geometry2 properties) are combined.
Public propertyHasAnimatedPropertiesGets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable.)
Public propertyIsFrozenGets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
Public propertyIsSealedGets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Public propertyTransformGets or sets the Transform object applied to a Geometry. (Inherited from Geometry.)
Top

  NameDescription
Public methodApplyAnimationClock(DependencyProperty, AnimationClock)Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.)
Public methodApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
Public methodBeginAnimation(DependencyProperty, AnimationTimeline)Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.)
Public methodBeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public methodClearValue(DependencyProperty)Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public methodCloneCreates a modifiable clone of this CombinedGeometry, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.
Public methodCloneCurrentValueCreates a modifiable clone of this CombinedGeometry object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are.
Public methodCoerceValueCoerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.)
Public methodEqualsDetermines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Public methodFillContains(Geometry)Indicates whether the current geometry completely contains the specified Geometry. (Inherited from Geometry.)
Public methodFillContains(Point)Indicates whether the geometry contains the specified Point. (Inherited from Geometry.)
Public methodFillContains(Geometry, Double, ToleranceType)Indicates whether the current geometry contains the specified Geometry, given the specified margin of error. (Inherited from Geometry.)
Public methodFillContains(Point, Double, ToleranceType)Indicates whether the geometry contains the specified Point, given the specified margin of error. (Inherited from Geometry.)
Public methodFillContainsWithDetail(Geometry)Returns a value that describes the intersection between the current geometry and the specified geometry. (Inherited from Geometry.)
Public methodFillContainsWithDetail(Geometry, Double, ToleranceType)Returns a value that describes the intersection between the current geometry and the specified geometry, given the specified margin of error. (Inherited from Geometry.)
Public methodFreeze()Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
Public methodGetAnimationBaseValueReturns the non-animated value of the specified DependencyProperty. (Inherited from Animatable.)
Public methodGetArea()Gets the area of the filled region of the Geometry object. (Inherited from Geometry.)
Public methodGetArea(Double, ToleranceType) Gets the area of the filled region. (Overrides Geometry.GetArea(Double, ToleranceType).)
Public methodGetAsFrozenCreates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
Public methodGetCurrentValueAsFrozenCreates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
Public methodGetFlattenedPathGeometry()Gets a PathGeometry that is a polygonal approximation of the Geometry object. (Inherited from Geometry.)
Public methodGetFlattenedPathGeometry(Double, ToleranceType)Gets a PathGeometry, within the specified tolerance, that is a polygonal approximation of the Geometry object. (Inherited from Geometry.)
Public methodGetHashCodeGets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public methodGetLocalValueEnumeratorCreates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Public methodGetOutlinedPathGeometry()Gets a PathGeometry that is a simplified outline of the filled region of the Geometry. (Inherited from Geometry.)
Public methodGetOutlinedPathGeometry(Double, ToleranceType)Gets a PathGeometry, within the specified tolerance, that is a simplified outline of the filled region of the Geometry. (Inherited from Geometry.)
Public methodGetRenderBounds(Pen)Returns an axis-aligned rectangle that is exactly large enough to contain the geometry after it has been outlined with the specified Pen. (Inherited from Geometry.)
Public methodGetRenderBounds(Pen, Double, ToleranceType)Returns an axis-aligned rectangle that is exactly large enough to contain the geometry after it has been outlined with the specified Pen, given the specified tolerance factor. (Inherited from Geometry.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public methodGetWidenedPathGeometry(Pen)Gets a PathGeometry that is the shape defined by the stroke on the Geometry produced by the specified Pen. (Inherited from Geometry.)
Public methodGetWidenedPathGeometry(Pen, Double, ToleranceType)Gets a PathGeometry that is the shape defined by the stroke on the Geometry produced by the specified Pen, given the specified tolerance factor. (Inherited from Geometry.)
Public methodInvalidatePropertyRe-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Public methodIsEmpty Determines whether this CombinedGeometry object is empty. (Overrides Geometry.IsEmpty().)
Public methodMayHaveCurves Determines whether this CombinedGeometry object may have curved segments. (Overrides Geometry.MayHaveCurves().)
Public methodReadLocalValueReturns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Public methodSetCurrentValueSets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
Public methodSetValue(DependencyProperty, Object)Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
Protected methodShouldSerializePropertyReturns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public methodShouldSerializeTransformGets a value that indicates whether the value of the Transform property should be serialized. (Inherited from Geometry.)
Public methodStrokeContains(Pen, Point)Determines whether the specified Point is contained in the stroke produced by applying the specified Pen to the geometry. (Inherited from Geometry.)
Public methodStrokeContains(Pen, Point, Double, ToleranceType)Determines whether the specified Point is contained in the stroke produced by applying the specified Pen to the geometry, given the specified margin of error. (Inherited from Geometry.)
Public methodStrokeContainsWithDetail(Pen, Geometry)Returns a value that describes the intersection between the specified Geometry and the stroke created by applying the specified Pen to the current geometry. (Inherited from Geometry.)
Public methodStrokeContainsWithDetail(Pen, Geometry, Double, ToleranceType)Gets a value that describes the intersection between the specified Geometry and the stroke created by applying the specified Pen to the current geometry, given the specified margin of error. (Inherited from Geometry.)
Public methodToString()Creates a string representation of the object based on the current culture. (Inherited from Geometry.)
Public methodToString(IFormatProvider)Creates a string representation of the object using the specified culture-specific formatting information. (Inherited from Geometry.)
Public methodVerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top

  NameDescription
Public eventChangedOccurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
Top

  NameDescription
Public fieldStatic memberGeometry1Property Identifies the Geometry1 dependency property.
Public fieldStatic memberGeometry2Property Identifies the Geometry2 dependency property.
Public fieldStatic memberGeometryCombineModePropertyIdentifies the GeometryCombineMode dependency property.
Top

  NameDescription
Explicit interface implemetationPrivate methodIFormattable.ToStringFormats the value of the current instance using the specified format. (Inherited from Geometry.)
Top

The GeometryCombineMode property specifies how the two geometries will be combined. Note that CombinedGeometry combines the area specified by two geometries, so geometries that do not have area (such as LineGeometry) disappear when combined.

Geometries can be combined in several ways: using a GeometryGroup, a CombinedGeometry, or the Combine method of the Geometry class.

  • A GeometryGroup creates a composite geometry from one or more Geometry objects.

  • A CombinedGeometry uses a specified boolean operation to combine the area described by two Geometry objects.

  • The static Combine method of the Geometry class behaves in exactly the same manner as the CombinedGeometry object.

Careful thought should be involved when using a CombinedGeometry to perform a union as it can be very CPU-expensive. In most cases, a GeometryGroup or AddGeometry will work better.

Use a CombinedGeometry only when any of the following apply:

  • The geometric operation is not a union.

  • Either of the geometries have a FillRule value of EvenOdd and the geometries are self-intersecting (i.e. the FillRule actually matters).

  • Time is not a concern, but space is (for instance, if the geometry is created once and then cached). Typically, CombinedGeometry produces smaller output than AddGeometry.

  • The resulting geometry will be stroked or used in a path animation and AddGeometry does not provide the desired outline.

Freezable Features

A CombinedGeometry is a type of Freezable object. For information about Freezable features, such as freezing and cloning, see the Freezable Objects Overview.

This example shows how to combine geometries. To combine two geometries, use a CombinedGeometry object. Set its Geometry1 and Geometry2 properties with the two geometries to combine, and set the GeometryCombineMode property, which determines how the geometries will be combined together, to Union, Intersect, Exclude, or Xor.

To create a composite geometry from two or more geometries, use a GeometryGroup.

In the following example, a CombinedGeometry is defined with a geometry combine mode of Exclude. Both Geometry1 and the Geometry2 are defined as circles of the same radius, but with centers offset by 50.

<Path Stroke="Black" StrokeThickness="1" Fill="#CCCCFF">
  <Path.Data>

    <!-- Combines two geometries using the exclude combine mode. -->
    <CombinedGeometry GeometryCombineMode="Exclude">
      <CombinedGeometry.Geometry1>
        <EllipseGeometry RadiusX="50" RadiusY="50" Center="75,75" />
      </CombinedGeometry.Geometry1>
      <CombinedGeometry.Geometry2>
        <EllipseGeometry RadiusX="50" RadiusY="50" Center="125,75" />
      </CombinedGeometry.Geometry2>
    </CombinedGeometry>
  </Path.Data>
</Path>
Combined Geometry Exclude

Results of the Exclude combine mode

In the following markup, a CombinedGeometry is defined with a combine mode of Intersect. Both Geometry1 and the Geometry2 are defined as circles of the same radius, but with centers offset by 50.

<Path Stroke="Black" StrokeThickness="1" Fill="#CCCCFF">
  <Path.Data>

    <!-- Combines two geometries using the intersect combine mode. -->
    <CombinedGeometry GeometryCombineMode="Intersect">
      <CombinedGeometry.Geometry1>
        <EllipseGeometry RadiusX="50" RadiusY="50" Center="75,75" />
      </CombinedGeometry.Geometry1>
      <CombinedGeometry.Geometry2>
        <EllipseGeometry RadiusX="50" RadiusY="50" Center="125,75" />
      </CombinedGeometry.Geometry2>
    </CombinedGeometry>
  </Path.Data>
</Path>
Combined Geometry Intersect

Results of the Intersect combine mode

In the following markup, a CombinedGeometry is defined with a combine mode of Union. Both Geometry1 and the Geometry2 are defined as circles of the same radius, but with centers offset by 50.

<Path Stroke="Black" StrokeThickness="1" Fill="#CCCCFF">
  <Path.Data>

    <!-- Combines two geometries using the union combine mode. -->
    <CombinedGeometry GeometryCombineMode="Union">
      <CombinedGeometry.Geometry1>
        <EllipseGeometry RadiusX="50" RadiusY="50" Center="75,75" />
      </CombinedGeometry.Geometry1>
      <CombinedGeometry.Geometry2>
        <EllipseGeometry RadiusX="50" RadiusY="50" Center="125,75" />
      </CombinedGeometry.Geometry2>
    </CombinedGeometry>
  </Path.Data>
</Path>
Combined Geometry Union

Results of the Union combine mode

In the following markup, a CombinedGeometry is defined with a combine mode of Xor. Both Geometry1 and the Geometry2 are defined as circles of the same radius, but with centers offset by 50.

<Path Stroke="Black" StrokeThickness="1" Fill="#CCCCFF">
  <Path.Data>

    <!-- Combines two geometries using the XOR combine mode. -->
    <CombinedGeometry GeometryCombineMode="Xor">
      <CombinedGeometry.Geometry1>
        <EllipseGeometry RadiusX="50" RadiusY="50" Center="75,75" />
      </CombinedGeometry.Geometry1>
      <CombinedGeometry.Geometry2>
        <EllipseGeometry RadiusX="50" RadiusY="50" Center="125,75" />
      </CombinedGeometry.Geometry2>
    </CombinedGeometry>
  </Path.Data>
</Path>
Combined Geometry Xor

Results of the Xor combine mode

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft