Table of Contents

Class BillboardTextGroupVisual3D

Namespace
HelixToolkit.Wpf
Assembly
HelixToolkit.Wpf.dll

A visual element that contains a collection of text billboards.

public class BillboardTextGroupVisual3D : RenderingModelVisual3D, IAnimatable, IAddChild, IBoundsIgnoredVisual3D
Inheritance
BillboardTextGroupVisual3D
Implements
Inherited Members
Extension Methods

Constructors

BillboardTextGroupVisual3D()

Initializes a new instance of the BillboardTextGroupVisual3D class.

public BillboardTextGroupVisual3D()

Fields

BackgroundProperty

Identifies the Background dependency property.

public static readonly DependencyProperty BackgroundProperty

Field Value

DependencyProperty

BorderBrushProperty

Identifies the BorderBrush dependency property.

public static readonly DependencyProperty BorderBrushProperty

Field Value

DependencyProperty

BorderThicknessProperty

Identifies the BorderThickness dependency property.

public static readonly DependencyProperty BorderThicknessProperty

Field Value

DependencyProperty

FontFamilyProperty

Identifies the FontFamily dependency property.

public static readonly DependencyProperty FontFamilyProperty

Field Value

DependencyProperty

FontSizeProperty

Identifies the FontSize dependency property.

public static readonly DependencyProperty FontSizeProperty

Field Value

DependencyProperty

FontWeightProperty

Identifies the FontWeight dependency property.

public static readonly DependencyProperty FontWeightProperty

Field Value

DependencyProperty

ForegroundProperty

Identifies the Foreground dependency property.

public static readonly DependencyProperty ForegroundProperty

Field Value

DependencyProperty

HeightFactorProperty

Identifies the HeightFactor dependency property.

public static readonly DependencyProperty HeightFactorProperty

Field Value

DependencyProperty

IsEnabledProperty

Identifies the IsEnabled dependency property.

public static readonly DependencyProperty IsEnabledProperty

Field Value

DependencyProperty

ItemsProperty

Identifies the Items dependency property.

public static readonly DependencyProperty ItemsProperty

Field Value

DependencyProperty

OffsetProperty

Identifies the Offset dependency property.

public static readonly DependencyProperty OffsetProperty

Field Value

DependencyProperty

PaddingProperty

Identifies the Padding dependency property.

public static readonly DependencyProperty PaddingProperty

Field Value

DependencyProperty

PinBrushProperty

Identifies the PinBrush dependency property.

public static readonly DependencyProperty PinBrushProperty

Field Value

DependencyProperty

PinWidthProperty

Identifies the PinWidth dependency property.

public static readonly DependencyProperty PinWidthProperty

Field Value

DependencyProperty

Properties

Background

Gets or sets the background.

public Brush Background { get; set; }

Property Value

Brush

The background.

BorderBrush

Gets or sets the border brush.

public Brush BorderBrush { get; set; }

Property Value

Brush

The border brush.

BorderThickness

Gets or sets the border thickness.

public Thickness BorderThickness { get; set; }

Property Value

Thickness

The border thickness.

FontFamily

Gets or sets the font family.

public FontFamily FontFamily { get; set; }

Property Value

FontFamily

The font family.

FontSize

Gets or sets the size of the font.

public double FontSize { get; set; }

Property Value

double

The size of the font.

FontWeight

Gets or sets the font weight.

public FontWeight FontWeight { get; set; }

Property Value

FontWeight

The font weight.

Foreground

Gets or sets the foreground brush.

public Brush Foreground { get; set; }

Property Value

Brush

The foreground.

HeightFactor

Gets or sets the height factor.

public double HeightFactor { get; set; }

Property Value

double

The height factor.

IsEnabled

Gets or sets a value indicating whether updating of this object is enabled.

public bool IsEnabled { get; set; }

Property Value

bool

true if this object is enabled; otherwise, false.

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

Items

Gets or sets the items.

public IList<BillboardTextItem> Items { get; set; }

Property Value

IList<BillboardTextItem>

The items.

Offset

Gets or sets the offset of the billboard text (in screen coordinates).

public Vector Offset { get; set; }

Property Value

Vector

The offset.

Padding

Gets or sets the padding.

public Thickness Padding { get; set; }

Property Value

Thickness

The padding.

PinBrush

Gets or sets the pin brush.

public Brush PinBrush { get; set; }

Property Value

Brush

The pin brush.

PinWidth

Gets or sets the width of the 'pin'.

public double PinWidth { get; set; }

Property Value

double

The width of the pin.

Remarks

You must set the Offset property for the pin to show up.

Methods

OnCompositionTargetRendering(object?, RenderingEventArgs?)

Handles the CompositionTarget.Rendering event.

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

Parameters

sender object

The sender.

eventArgs RenderingEventArgs

The RenderingEventArgs instance containing the event data.

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.

Edit this page