Class BillboardRenderer

Renders a Billboard on the screen. The owner Entity must contain the Billboard to be drawn, as well as a Transform3D.

Inheritance
object
IdentifiableObject
DependencyObject
AttachableObject
PrefabInstanceObject
Component
Drawable
Drawable3D
BillboardRenderer
Implements
Inherited Members
Namespace: Evergine.Components.Graphics3D
Assembly: Evergine.Components.dll
Syntax
public class BillboardRenderer : Drawable3D, IDependencyObject

Constructors

BillboardRenderer()

Initializes a new instance of the BillboardRenderer class.

Declaration
public BillboardRenderer()

Fields

Billboard

Required Transform3D. It indicates where to draw the Billboard, which rotation to apply, and what scale to use.

Declaration
[BindComponent(true, true, BindComponentSource.Owner, null, true)]
public Billboard Billboard
Field Value
Type Description
Billboard

Transform3D

Required Transform3D. It specifies where to draw the Billboard, which rotation to apply, and which scale.

Declaration
[BindComponent(true, true, BindComponentSource.Owner, null, true)]
public Transform3D Transform3D
Field Value
Type Description
Transform3D

assetsService

The Assets service.

Declaration
[BindService(true)]
protected AssetsService assetsService
Field Value
Type Description
AssetsService

Properties

Layer

Gets or sets the type of the layer.

Declaration
public RenderLayerDescription Layer { get; set; }
Property Value
Type Description
RenderLayerDescription

The type of the layer.

Methods

Draw(DrawContext)

Allows custom drawing.

Declaration
public override void Draw(DrawContext drawContext)
Parameters
Type Name Description
DrawContext drawContext

The draw context.
Overrides
Remarks

This method will only be called if all the following points are true:

  • The entity passes the culling test.
  • The parent of the owner Entity of the Drawable cascades its visibility to its children and is visible.
  • The Drawable is active.
  • The owner Entity of the Drawable is active and visible.

OnActivated()

Invoked when the object is activated once it is attached.

Declaration
protected override void OnActivated()
Overrides

OnAttached()

Invoked when the object is attached to the system.

Declaration
protected override bool OnAttached()
Returns
Type Description
bool

True if everything is OK.
Overrides

OnDeactivated()

Invoked when the object is deactivated.

Declaration
protected override void OnDeactivated()
Overrides

OnDestroy()

Invoked when the object is about to be disposed.

Declaration
protected override void OnDestroy()
Overrides

OnDetached()

Invoked when the object is detached.

Declaration
protected override void OnDetached()
Overrides

OnLoaded()

Invoked when the object is loaded.

Declaration
protected override void OnLoaded()
Overrides

Implements

Extension Methods