CombinedGeometry Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a 2-D geometric shape defined by the combination of two Geometry objects.
public ref class CombinedGeometry sealed : System::Windows::Media::Geometrypublic sealed class CombinedGeometry : System.Windows.Media.Geometrytype CombinedGeometry = class
inherit GeometryPublic NotInheritable Class CombinedGeometry
Inherits Geometry- Inheritance
Remarks
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.
Constructors
| CombinedGeometry() |
Initializes a new instance of the CombinedGeometry class. |
| CombinedGeometry(Geometry, Geometry) |
Initializes a new instance of the CombinedGeometry class with the specified Geometry objects. |
| CombinedGeometry(GeometryCombineMode, Geometry, Geometry) |
Initializes a new instance of the CombinedGeometry class with the specified Geometry objects and GeometryCombineMode. |
| CombinedGeometry(GeometryCombineMode, Geometry, Geometry, Transform) |
Initializes a new instance of the CombinedGeometry class with the specified Geometry objects, GeometryCombineMode, and Transform. |
Fields
| Geometry1Property |
Identifies the Geometry1 dependency property. |
| Geometry2Property |
Identifies the Geometry2 dependency property. |
| GeometryCombineModeProperty |
Identifies the GeometryCombineMode dependency property. |
Properties
| Bounds |
Gets a Rect that specifies the bounding box of this CombinedGeometry object. Note: This method does not take any pens into account. |
| CanFreeze |
Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable) |
| DependencyObjectType |
Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject) |
| Dispatcher |
Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject) |
| Geometry1 |
Gets or sets the first Geometry object of this CombinedGeometry object. |
| Geometry2 |
Gets or sets the second Geometry object of this CombinedGeometry object. |
| GeometryCombineMode |
Gets or sets the method by which the two geometries (specified by the Geometry1 and Geometry2 properties) are combined. |
| HasAnimatedProperties |
Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable) |
| IsFrozen |
Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable) |
| IsSealed |
Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject) |
| Transform |
Gets or sets the Transform object applied to a Geometry. (Inherited from Geometry) |
Methods
| ApplyAnimationClock(DependencyProperty, AnimationClock) |
Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable) |
| ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior) |
Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable) |
| BeginAnimation(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) |
| BeginAnimation(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) |
| CheckAccess() |
Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject) |
| ClearValue(DependencyProperty) |
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject) |
| ClearValue(DependencyPropertyKey) |
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject) |
| Clone() |
Creates 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. |
| CloneCore(Freezable) |
Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. (Inherited from Freezable) |
| CloneCurrentValue() |
Creates 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. |
| CloneCurrentValueCore(Freezable) |
Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. (Inherited from Freezable) |
| CoerceValue(DependencyProperty) |
Coerces 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) |
| CreateInstance() |
Initializes a new instance of the Freezable class. (Inherited from Freezable) |
| CreateInstanceCore() |
When implemented in a derived class, creates a new instance of the Freezable derived class. (Inherited from Freezable) |
| Equals(Object) |
Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject) |
| FillContains(Geometry) |
Indicates whether the current geometry completely contains the specified Geometry. (Inherited from Geometry) |
| FillContains(Geometry, Double, ToleranceType) |
Indicates whether the current geometry contains the specified Geometry, given the specified margin of error. (Inherited from Geometry) |
| FillContains(Point) |
Indicates whether the geometry contains the specified Point. (Inherited from Geometry) |
| FillContains(Point, Double, ToleranceType) |
Indicates whether the geometry contains the specified Point, given the specified margin of error. (Inherited from Geometry) |
| FillContainsWithDetail(Geometry) |
Returns a value that describes the intersection between the current geometry and the specified geometry. (Inherited from Geometry) |
| FillContainsWithDetail(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) |
| Freeze() |
Makes the current object unmodifiable and sets its IsFrozen property to |
| FreezeCore(Boolean) |
Makes this Animatable object unmodifiable or determines whether it can be made unmodifiable. (Inherited from Animatable) |
| GetAnimationBaseValue(DependencyProperty) |
Returns the non-animated value of the specified DependencyProperty. (Inherited from Animatable) |
| GetArea() |
Gets the area of the filled region of the Geometry object. (Inherited from Geometry) |
| GetArea(Double, ToleranceType) |
Gets the area of the filled region. |
| GetAsFrozen() |
Creates 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) |
| GetAsFrozenCore(Freezable) |
Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values. (Inherited from Freezable) |
| GetCurrentValueAsFrozen() |
Creates 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) |
| GetCurrentValueAsFrozenCore(Freezable) |
Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied. (Inherited from Freezable) |
| GetFlattenedPathGeometry() |
Gets a PathGeometry that is a polygonal approximation of the Geometry object. (Inherited from Geometry) |
| GetFlattenedPathGeometry(Double, ToleranceType) |
Gets a PathGeometry, within the specified tolerance, that is a polygonal approximation of the Geometry object. (Inherited from Geometry) |
| GetHashCode() |
Gets a hash code for this DependencyObject. (Inherited from DependencyObject) |
| GetLocalValueEnumerator() |
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject) |
| GetOutlinedPathGeometry() |
Gets a PathGeometry that is a simplified outline of the filled region of the Geometry. (Inherited from Geometry) |
| GetOutlinedPathGeometry(Double, ToleranceType) |
Gets a PathGeometry, within the specified tolerance, that is a simplified outline of the filled region of the Geometry. (Inherited from Geometry) |
| GetRenderBounds(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) |
| GetRenderBounds(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) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| GetValue(DependencyProperty) |
Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject) |
| GetWidenedPathGeometry(Pen) |
Gets a PathGeometry that is the shape defined by the stroke on the Geometry produced by the specified Pen. (Inherited from Geometry) |
| GetWidenedPathGeometry(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) |
| InvalidateProperty(DependencyProperty) |
Re-evaluates the effective value for the specified dependency property. (Inherited from DependencyObject) |
| IsEmpty() |
Determines whether this CombinedGeometry object is empty. |
| MayHaveCurves() |
Determines whether this CombinedGeometry object may have curved segments. |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| OnChanged() |
Called when the current Freezable object is modified. (Inherited from Freezable) |
| OnFreezablePropertyChanged(DependencyObject, DependencyObject) |
Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable) |
| OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) |
This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from Freezable) |
| OnPropertyChanged(DependencyPropertyChangedEventArgs) |
Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable) |
| ReadLocalValue(DependencyProperty) |
Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject) |
| ReadPreamble() |
Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. (Inherited from Freezable) |
| SetCurrentValue(DependencyProperty, Object) |
Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject) |
| SetValue(DependencyProperty, Object) |
Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject) |
| SetValue(DependencyPropertyKey, Object) |
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject) |
| ShouldSerializeProperty(DependencyProperty) |
Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject) |
| ShouldSerializeTransform() |
Gets a value that indicates whether the value of the Transform property should be serialized. (Inherited from Geometry) |
| StrokeContains(Pen, Point) |
Determines whether the specified Point is contained in the stroke produced by applying the specified Pen to the geometry. (Inherited from Geometry) |
| StrokeContains(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) |
| StrokeContainsWithDetail(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) |
| StrokeContainsWithDetail(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) |
| ToString() |
Creates a string representation of the object based on the current culture. (Inherited from Geometry) |
| ToString(IFormatProvider) |
Creates a string representation of the object using the specified culture-specific formatting information. (Inherited from Geometry) |
| VerifyAccess() |
Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject) |
| WritePostscript() |
Raises the Changed event for the Freezable and invokes its OnChanged() method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. (Inherited from Freezable) |
| WritePreamble() |
Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable) |
Events
| Changed |
Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable) |
Explicit Interface Implementations
| IFormattable.ToString(String, IFormatProvider) |
Formats the value of the current instance using the specified format. (Inherited from Geometry) |
