Class BillboardVisual3D

Namespace

HelixToolkit.Wpf

Assembly

HelixToolkit.Wpf.dll

A visual element that contains a billboard (a quadrilateral that always faces camera). The size of the billboard is defined in screen space.

public class BillboardVisual3D : RenderingModelVisual3D, IAnimatable, IAddChild

Inheritance

object

DispatcherObject

DependencyObject

Visual3D

ModelVisual3D

RenderingModelVisual3D

BillboardVisual3D

Implements

IAnimatable

IAddChild

Derived

BillboardTextVisual3D

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

BillboardVisual3D()

Initializes a new instance of the BillboardVisual3D class.

public BillboardVisual3D()

Fields

DepthOffsetProperty

Identifies the DepthOffset dependency property.

public static readonly DependencyProperty DepthOffsetProperty

Field Value

DependencyProperty

HeightProperty

Identifies the Height dependency property.

public static readonly DependencyProperty HeightProperty

Field Value

DependencyProperty

HorizontalAlignmentProperty

Identifies the HorizontalAlignment dependency property.

public static readonly DependencyProperty HorizontalAlignmentProperty

Field Value

DependencyProperty

MaterialProperty

Identifies the Material dependency property.

public static readonly DependencyProperty MaterialProperty

Field Value

DependencyProperty

PositionProperty

Identifies the Position dependency property.

public static readonly DependencyProperty PositionProperty

Field Value

DependencyProperty

VerticalAlignmentProperty

Identifies the VerticalAlignment dependency property.

public static readonly DependencyProperty VerticalAlignmentProperty

Field Value

DependencyProperty

WidthProperty

Identifies the Width dependency property.

public static readonly DependencyProperty WidthProperty

Field Value

DependencyProperty

Properties

DepthOffset

Gets or sets the depth offset.

public double DepthOffset { get; set; }

Property Value

double

The depth offset.

Height

Gets or sets the height.

public double Height { get; set; }

Property Value

double

The height.

HorizontalAlignment

Gets or sets the horizontal alignment.

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

HorizontalAlignment

The horizontal alignment.

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

Material

Gets or sets the material.

public Material? Material { get; set; }

Property Value

Material

The material.

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

Position

Gets or sets the position (center) of the billboard.

public Point3D Position { get; set; }

Property Value

Point3D

The position.

VerticalAlignment

Gets or sets the vertical alignment.

public VerticalAlignment VerticalAlignment { get; set; }

Property Value

VerticalAlignment

The vertical alignment.

Width

Gets or sets the width.

public double Width { get; set; }

Property Value

double

The width.

Methods

GeometryChanged(DependencyObject, DependencyPropertyChangedEventArgs)

The geometry changed.

protected static void GeometryChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)

Parameters

d DependencyObject

The sender.

e DependencyPropertyChangedEventArgs

The event arguments.

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.

OnMaterialChanged()

The on material changed.

public void OnMaterialChanged()

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 void UpdateGeometry()

UpdateTransforms()

Updates the transforms.

protected bool UpdateTransforms()

Returns

bool

True if the transform is updated.