Class BillboardSingleText3D
- Namespace
- HelixToolkit.SharpDX
- Assembly
- HelixToolkit.SharpDX.dll
public class BillboardSingleText3D : BillboardBase, INotifyPropertyChanged, IGUID, IBillboardText
- Inheritance
-
BillboardSingleText3D
- Implements
- Inherited Members
- Extension Methods
Constructors
BillboardSingleText3D()
Initializes a new instance of the BillboardSingleText3D class.
public BillboardSingleText3D()
BillboardSingleText3D(float, float)
Initializes a new instance of the BillboardSingleText3D class.
public BillboardSingleText3D(float width, float height)
Parameters
Properties
BackgroundColor
Gets or sets the color of the background.
public Color4 BackgroundColor { get; set; }
Property Value
- Color4
The color of the background.
FontColor
Gets or sets the color of the font.
public Color4 FontColor { get; set; }
Property Value
- Color4
The color of the font.
FontFamily
Gets or sets the font family.
public string FontFamily { get; set; }
Property Value
- string
The font family.
FontSize
Gets or sets the size of the font.
public int FontSize { get; set; }
Property Value
- int
The size of the font.
FontStyle
Gets or sets the font style.
public FontStyle FontStyle { get; set; }
Property Value
- FontStyle
The font style.
FontWeight
Gets or sets the font weight.
public FontWeight FontWeight { get; set; }
Property Value
- FontWeight
The font weight.
HorizontalAlignment
Sets or gets the horizontal alignment. Default = Center
For example, when sets horizontal and vertical alignment to top/left, billboard's bottom/right point will be anchored at the billboard origin.
public BillboardHorizontalAlignment HorizontalAlignment { get; set; }
Property Value
- BillboardHorizontalAlignment
The horizontal alignment.
Offset
Additional offset for billboard display location. Behavior depends on whether billboard is fixed sized or not. When billboard is fixed sized, the offset is screen spaced.
public Vector2 Offset { get; set; }
Property Value
Padding
Gets or sets the padding.
public Thickness Padding { get; set; }
Property Value
- Thickness
The padding.
TextInfo
Gets or sets the text information.
public TextInfo? TextInfo { get; set; }
Property Value
- TextInfo
The text information.
Type
Billboard type, BillboardType
public override BillboardType Type { get; }
Property Value
VerticalAlignment
Sets or gets the vertical alignment. Default = Center
For example, when sets horizontal and vertical alignment to top/left, billboard's bottom/right point will be anchored at the billboard origin.
public BillboardVerticalAlignment VerticalAlignment { get; set; }
Property Value
- BillboardVerticalAlignment
The vertical alignment.
Methods
AssignResultAdditional(BillboardHitResult, int)
protected override void AssignResultAdditional(BillboardHitResult result, int index)
Parameters
resultBillboardHitResultindexint
HitTest(HitTestContext?, Matrix4x4, ref List<HitTestResult>, object?, bool)
Hits the test.
public override bool HitTest(HitTestContext? context, Matrix4x4 modelMatrix, ref List<HitTestResult> hits, object? originalSource, bool fixedSize)
Parameters
contextHitTestContextThe context.
modelMatrixMatrix4x4The model matrix.
hitsList<HitTestResult>The hits.
originalSourceobjectThe original source.
fixedSizeboolif set to
true[fixed size].
Returns
OnAssignTo(Geometry3D)
protected override void OnAssignTo(Geometry3D target)
Parameters
targetGeometry3D
OnUpdateTextureAndBillboardVertices(IDeviceResources)
Called when [draw texture].
protected override void OnUpdateTextureAndBillboardVertices(IDeviceResources deviceResources)
Parameters
deviceResourcesIDeviceResourcesThe device resources.
UpdateBounds()
Updates the bounds.
public override void UpdateBounds()