From 558f98f5bf5e9ca09d89cc09baa32cec300d83fa Mon Sep 17 00:00:00 2001 From: Steven Kirk Date: Mon, 23 Jan 2017 19:41:37 +0100 Subject: [PATCH] Remove refrences to "scene graph" in Visual. As its now a separate thing. --- src/Avalonia.Visuals/Visual.cs | 35 +++++++++++----------- src/Avalonia.Visuals/VisualTree/IVisual.cs | 30 +++++++++---------- 2 files changed, 32 insertions(+), 33 deletions(-) diff --git a/src/Avalonia.Visuals/Visual.cs b/src/Avalonia.Visuals/Visual.cs index 11f2f4ad25..1ffd0a821f 100644 --- a/src/Avalonia.Visuals/Visual.cs +++ b/src/Avalonia.Visuals/Visual.cs @@ -10,7 +10,6 @@ using Avalonia.Collections; using Avalonia.Data; using Avalonia.Logging; using Avalonia.Media; -using Avalonia.Platform; using Avalonia.Rendering; using Avalonia.VisualTree; @@ -20,10 +19,10 @@ namespace Avalonia /// Base class for controls that provides rendering and related visual properties. /// /// - /// The class acts as a node in the Avalonia scene graph and holds - /// all the information needed for an to render the control. - /// To traverse the scene graph (aka Visual Tree), use the extension methods defined - /// in . + /// The class represents elements that have a visual on-screen + /// representation and stores all the information needed for an + /// to render the control. To traverse the visual tree, use the + /// extension methods defined in . /// public class Visual : Animatable, IVisual { @@ -128,7 +127,7 @@ namespace Avalonia public event EventHandler DetachedFromVisualTree; /// - /// Gets the bounds of the scene graph node relative to its parent. + /// Gets the bounds of the control relative to its parent. /// public Rect Bounds { @@ -137,7 +136,7 @@ namespace Avalonia } /// - /// Gets a value indicating whether the scene graph node should be clipped to its bounds. + /// Gets a value indicating whether the control should be clipped to its bounds. /// public bool ClipToBounds { @@ -155,7 +154,7 @@ namespace Avalonia } /// - /// Gets a value indicating whether this scene graph node and all its parents are visible. + /// Gets a value indicating whether this control and all its parents are visible. /// public bool IsEffectivelyVisible { @@ -163,7 +162,7 @@ namespace Avalonia } /// - /// Gets a value indicating whether this scene graph node is visible. + /// Gets a value indicating whether this control is visible. /// public bool IsVisible { @@ -172,7 +171,7 @@ namespace Avalonia } /// - /// Gets the opacity of the scene graph node. + /// Gets the opacity of the control. /// public double Opacity { @@ -181,7 +180,7 @@ namespace Avalonia } /// - /// Gets the opacity mask of the scene graph node. + /// Gets the opacity mask of the control. /// public IBrush OpacityMask { @@ -190,7 +189,7 @@ namespace Avalonia } /// - /// Gets the render transform of the scene graph node. + /// Gets the render transform of the control. /// public Transform RenderTransform { @@ -199,7 +198,7 @@ namespace Avalonia } /// - /// Gets the transform origin of the scene graph node. + /// Gets the transform origin of the control. /// public RelativePoint RenderTransformOrigin { @@ -208,7 +207,7 @@ namespace Avalonia } /// - /// Gets the Z index of the node. + /// Gets the Z index of the control. /// /// /// Controls with a higher will appear in front of controls with @@ -222,7 +221,7 @@ namespace Avalonia } /// - /// Gets the control's visual children. + /// Gets the control's child visuals. /// protected IAvaloniaList VisualChildren { @@ -236,17 +235,17 @@ namespace Avalonia protected IRenderRoot VisualRoot => _visualRoot ?? (this as IRenderRoot); /// - /// Gets a value indicating whether this scene graph node is attached to a visual root. + /// Gets a value indicating whether this control is attached to a visual root. /// bool IVisual.IsAttachedToVisualTree => VisualRoot != null; /// - /// Gets the scene graph node's child nodes. + /// Gets the control's child controls. /// IAvaloniaReadOnlyList IVisual.VisualChildren => VisualChildren; /// - /// Gets the scene graph node's parent node. + /// Gets the control's parent visual. /// IVisual IVisual.VisualParent => _visualParent; diff --git a/src/Avalonia.Visuals/VisualTree/IVisual.cs b/src/Avalonia.Visuals/VisualTree/IVisual.cs index b9b37b1a20..2047996c3e 100644 --- a/src/Avalonia.Visuals/VisualTree/IVisual.cs +++ b/src/Avalonia.Visuals/VisualTree/IVisual.cs @@ -9,13 +9,13 @@ using Avalonia.Rendering; namespace Avalonia.VisualTree { /// - /// Represents a node in the visual scene graph. + /// Represents control that has a visual on-screen representation. /// /// /// The interface defines the interface required for a renderer to - /// render a scene graph. You should not usually need to reference this interface unless + /// render a control. You should not usually need to reference this interface unless /// you are writing a renderer; instead use the extension methods defined in - /// to traverse the scene graph. This interface is + /// to traverse the visual tree. This interface is /// implemented by . It should not be necessary to implement it /// anywhere else. /// @@ -32,12 +32,12 @@ namespace Avalonia.VisualTree event EventHandler DetachedFromVisualTree; /// - /// Gets the bounds of the scene graph node relative to its parent. + /// Gets the bounds of the control relative to its parent. /// Rect Bounds { get; } /// - /// Gets a value indicating whether the scene graph node should be clipped to its bounds. + /// Gets a value indicating whether the control should be clipped to its bounds. /// bool ClipToBounds { get; set; } @@ -47,47 +47,47 @@ namespace Avalonia.VisualTree Geometry Clip { get; set; } /// - /// Gets a value indicating whether this scene graph node is attached to a visual root. + /// Gets a value indicating whether this control is attached to a visual root. /// bool IsAttachedToVisualTree { get; } /// - /// Gets a value indicating whether this scene graph node and all its parents are visible. + /// Gets a value indicating whether this control and all its parents are visible. /// bool IsEffectivelyVisible { get; } /// - /// Gets or sets a value indicating whether this scene graph node is visible. + /// Gets or sets a value indicating whether this control is visible. /// bool IsVisible { get; set; } /// - /// Gets or sets the opacity of the scene graph node. + /// Gets or sets the opacity of the control. /// double Opacity { get; set; } /// - /// Gets or sets the opacity mask of the scene graph node. + /// Gets or sets the opacity mask for the control. /// IBrush OpacityMask { get; set; } /// - /// Gets or sets the render transform of the scene graph node. + /// Gets or sets the render transform of the control. /// Transform RenderTransform { get; set; } /// - /// Gets or sets the render transform origin of the scene graph node. + /// Gets or sets the render transform origin of the control. /// RelativePoint RenderTransformOrigin { get; set; } /// - /// Gets the scene graph node's child nodes. + /// Gets the control's child visuals. /// IAvaloniaReadOnlyList VisualChildren { get; } /// - /// Gets the scene graph node's parent node. + /// Gets the control's parent visual. /// IVisual VisualParent { get; } @@ -107,7 +107,7 @@ namespace Avalonia.VisualTree void InvalidateVisual(); /// - /// Renders the scene graph node to a . + /// Renders the control to a . /// /// The context. void Render(DrawingContext context);