Class ScreenSpaceVisual3D

Namespace

HelixToolkit.Wpf

Assembly

HelixToolkit.Wpf.dll

An abstract base class for visuals that use screen space dimensions when rendering.

public abstract class ScreenSpaceVisual3D : RenderingModelVisual3D, IAnimatable, IAddChild

Inheritance

object

DispatcherObject

DependencyObject

Visual3D

ModelVisual3D

RenderingModelVisual3D

ScreenSpaceVisual3D

Implements

IAnimatable

IAddChild

Derived

LinesVisual3D

PointsVisual3D

Inherited Members

RenderingModelVisual3D.SubscribeToRenderingEvent()

RenderingModelVisual3D.UnsubscribeRenderingEvent()

ModelVisual3D.ContentProperty

ModelVisual3D.TransformProperty

ModelVisual3D.GetVisual3DChild(int)

ModelVisual3D.Children

ModelVisual3D.Content

ModelVisual3D.Transform

ModelVisual3D.Visual3DChildrenCount

Visual3D.AddVisual3DChild(Visual3D)

Visual3D.ApplyAnimationClock(DependencyProperty, AnimationClock)

Visual3D.ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)

Visual3D.BeginAnimation(DependencyProperty, AnimationTimeline)

Visual3D.BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)

Visual3D.FindCommonVisualAncestor(DependencyObject)

Visual3D.GetAnimationBaseValue(DependencyProperty)

Visual3D.IsAncestorOf(DependencyObject)

Visual3D.IsDescendantOf(DependencyObject)

Visual3D.OnVisualChildrenChanged(DependencyObject, DependencyObject)

Visual3D.RemoveVisual3DChild(Visual3D)

Visual3D.TransformToAncestor(Visual3D)

Visual3D.TransformToAncestor(Visual)

Visual3D.TransformToDescendant(Visual3D)

Visual3D.HasAnimatedProperties

Visual3D.Visual3DModel

DependencyObject.ClearValue(DependencyProperty)

DependencyObject.ClearValue(DependencyPropertyKey)

DependencyObject.CoerceValue(DependencyProperty)

DependencyObject.Equals(object)

DependencyObject.GetHashCode()

DependencyObject.GetLocalValueEnumerator()

DependencyObject.GetValue(DependencyProperty)

DependencyObject.InvalidateProperty(DependencyProperty)

DependencyObject.OnPropertyChanged(DependencyPropertyChangedEventArgs)

DependencyObject.ReadLocalValue(DependencyProperty)

DependencyObject.SetCurrentValue(DependencyProperty, object)

DependencyObject.SetValue(DependencyProperty, object)

DependencyObject.SetValue(DependencyPropertyKey, object)

DependencyObject.ShouldSerializeProperty(DependencyProperty)

DependencyObject.DependencyObjectType

DependencyObject.IsSealed

DispatcherObject.Dispatcher

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

AttachedProperties.GetName(DependencyObject)

AttachedProperties.SetName(DependencyObject, string)

AnimationExtensions.AnimateOpacity(IAnimatable, double, double)

Visual3DHelper.FindBounds(Visual3D, Transform3D)

Visual3DHelper.GetTransform(Visual3D)

Visual3DHelper.GetTransformTo(Visual3D, Model3D)

Visual3DHelper.GetViewport(Visual3D)

Visual3DHelper.GetViewport3D(Visual3D)

Visual3DHelper.GetViewportTransform(Visual3D)

Visual3DHelper.IsAttachedToViewport3D(Visual3D)

Visual3DHelper.Traverse<T>(Visual3D, Action<T, Transform3D>)

Visual3DHelper.Traverse<T>(Visual3D, Action<T, Visual3D, Transform3D>)

Constructors

ScreenSpaceVisual3D()

Initializes a new instance of the ScreenSpaceVisual3D class.

protected ScreenSpaceVisual3D()

Fields

ColorProperty

Identifies the Color dependency property.

public static readonly DependencyProperty ColorProperty

Field Value

DependencyProperty

DepthOffsetProperty

Identifies the DepthOffset dependency property.

public static readonly DependencyProperty DepthOffsetProperty

Field Value

DependencyProperty

PointsProperty

Identifies the Points dependency property.

public static readonly DependencyProperty PointsProperty

Field Value

DependencyProperty

Properties

Clipping

Gets or sets the clipping object.

protected CohenSutherlandClipping? Clipping { get; set; }

Property Value

CohenSutherlandClipping

Color

Gets or sets the color.

public Color Color { get; set; }

Property Value

Color

The color.

DepthOffset

Gets or sets the depth offset. A small positive number (0.0001) will move the visual slightly in front of other objects.

public double DepthOffset { get; set; }

Property Value

double

The depth offset.

IsRendering

Gets or sets a value indicating whether this instance is being rendered. When the visual is removed from the visual tree, this property should be set to false.

public bool IsRendering { get; set; }

Property Value

bool

Mesh

Gets or sets the mesh.

protected MeshGeometry3D Mesh { get; set; }

Property Value

MeshGeometry3D

Model

Gets or sets the model.

protected GeometryModel3D Model { get; set; }

Property Value

GeometryModel3D

Points

Gets or sets the points collection.

public Point3DCollection Points { get; set; }

Property Value

Point3DCollection

The points collection.

Methods

GeometryChanged(object?, DependencyPropertyChangedEventArgs)

Called when geometry properties have changed.

protected static void GeometryChanged(object? sender, DependencyPropertyChangedEventArgs e)

Parameters

sender object

The sender.

e DependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

OnCompositionTargetRendering(object?, RenderingEventArgs?)

The composition target_ rendering.

protected override void OnCompositionTargetRendering(object? sender, RenderingEventArgs? e)

Parameters

sender object

The sender.

e RenderingEventArgs

The event arguments.

OnVisualParentChanged(DependencyObject)

Called when the parent of the 3-D visual object is changed.

protected override void OnVisualParentChanged(DependencyObject oldParent)

Parameters

oldParent DependencyObject

A value of type DependencyObject that represents the previous parent of the Visual3D object. If the Visual3D object did not have a previous parent, the value of the parameter is null.

UpdateGeometry()

Updates the geometry.

protected abstract void UpdateGeometry()

UpdateTransforms()

Updates the transforms.

protected abstract bool UpdateTransforms()

Returns

bool

True if the transform is updated.