Entity3D Class

Delta Engine Documentation

Base entity for 3D objects. Usually used in Meshes or Models, both normally Actors. View code on GitHub

Inheritance Hierarchy

System Object
  DeltaEngine.Entities Entity
    DeltaEngine.Entities DrawableEntity
      DeltaEngine.Rendering3D Entity3D
        DeltaEngine.Rendering3D Billboard
        DeltaEngine.Rendering3D HierarchyEntity3D
        DeltaEngine.Rendering3D.Shapes Circle3D
        DeltaEngine.Rendering3D.Shapes Grid3D
        DeltaEngine.Rendering3D.Shapes Line3D

Namespace: DeltaEngine.Rendering3D
Assembly: DeltaEngine.Rendering3D (in DeltaEngine.Rendering3D.dll) Version: 1.1.1.0 (1.1.1)

Syntax

C++

Copy to Clipboard Print

public class Entity3D : DrawableEntity

public class Entity3D : DrawableEntity

Public Class Entity3D 
	Inherits DrawableEntity

Public Class Entity3D 
	Inherits DrawableEntity

public ref class Entity3D : public DrawableEntity

public ref class Entity3D : public DrawableEntity

type Entity3D =  
    class 
        inherit DrawableEntity 
    end

type Entity3D =  
    class 
        inherit DrawableEntity 
    end

The Entity3D type exposes the following members.

Constructors

	Name	Description
	Entity3D(Vector3D)	Initializes a new instance of the Entity3D class
	Entity3D(Vector3D, Quaternion)	Initializes a new instance of the Entity3D class

Top

Methods

	Name	Description
	Add T	(Overrides DrawableEntity Add T (T).)
	AddTag	View code on GitHub (Inherited from Entity.)
	ClearTags	View code on GitHub (Inherited from Entity.)
	Contains T	(Overrides Entity Contains T .)
	ContainsBehavior T	(Inherited from Entity.)
	ContainsTag	View code on GitHub (Inherited from Entity.)
	Deactivate	(Inherited from Entity.)
	Dispose	View code on GitHub (Inherited from Entity.)
	Get T	(Overrides DrawableEntity Get T .)
	GetActiveBehaviors	(Inherited from Entity.)
	GetComponentsForSaving	(Overrides Entity GetComponentsForSaving .)
	GetDrawBehaviors	(Inherited from DrawableEntity.)
	GetInterpolatedArray T	(Inherited from DrawableEntity.)
	GetInterpolatedList T	(Inherited from DrawableEntity.)
	GetOrDefault T	(Inherited from Entity.)
	GetTags	View code on GitHub (Inherited from Entity.)
	NextUpdateStarted	(Overrides DrawableEntity NextUpdateStarted .)
	OnDraw T	(Inherited from DrawableEntity.)
	OnOrientationChanged
	OnPositionChanged
	OnScaleChanged
	Remove T	(Inherited from Entity.)
	RemoveTag	View code on GitHub (Inherited from Entity.)
	Set	View code on GitHub (Overrides DrawableEntity Set(Object).)
	SetComponents	(Inherited from Entity.)
	SetWithoutInterpolation T	(Overrides DrawableEntity SetWithoutInterpolation T (T).)
	Start T	(Inherited from Entity.)
	Stop T	(Inherited from Entity.)
	ToggleVisibility	(Inherited from DrawableEntity.)
	ToString	View code on GitHub (Inherited from Entity.)

Top

Fields

	Name	Description
	components	(Inherited from Entity.)
	lastOrientation
	lastPosition
	lastTickLerpComponents	Each element can either be a Lerp, a Lerp List or an array of Lerp objects. View code on GitHub (Inherited from DrawableEntity.)

Top

Properties

	Name	Description
	IsActive	View code on GitHub (Inherited from DrawableEntity.)
	IsPauseable	View code on GitHub (Inherited from Entity.)
	IsVisible	View code on GitHub (Inherited from DrawableEntity.)
	NumberOfComponents	View code on GitHub (Inherited from Entity.)
	Orientation	View code on GitHub
	Position	View code on GitHub
	RenderLayer	View code on GitHub (Inherited from DrawableEntity.)
	Scale	View code on GitHub
	UpdatePriority	View code on GitHub (Inherited from Entity.)

Top

Remarks

Tests: DeltaEngine.Rendering3D.Tests.Entity3DTests

Examples

10 unit tests call DeltaEngine.Rendering3D.Entity3D

Copy to Clipboard Print

[Test, CloseAfterFirstFrame]
public void CreateEntity3D()
{
    var entity = new Entity3D(Vector3D.Zero);
    entity.Add(Rectangle.One);
    Assert.AreEqual(Vector3D.Zero, entity.Position);
    Assert.AreEqual(Quaternion.Identity, entity.Orientation);
    Assert.IsTrue(entity.IsVisible);
    Assert.AreEqual(4, entity.GetComponentsForSaving().Count);
}

[Test, CloseAfterFirstFrame]
public void CreateEntity3D()
{
    var entity = new Entity3D(Vector3D.Zero);
    entity.Add(Rectangle.One);
    Assert.AreEqual(Vector3D.Zero, entity.Position);
    Assert.AreEqual(Quaternion.Identity, entity.Orientation);
    Assert.IsTrue(entity.IsVisible);
    Assert.AreEqual(4, entity.GetComponentsForSaving().Count);
}

Copy to Clipboard Print

[Test, CloseAfterFirstFrame]
public void CreateEntity3DPositionAndOrientation()
{
    var position = new Vector3D(10.0f, -3.0f, 27.0f);
    var orientation = Quaternion.Identity;
    var entity = new Entity3D(position, orientation);
    Assert.AreEqual(position, entity.Position);
    Assert.AreEqual(orientation, entity.Orientation);
}

[Test, CloseAfterFirstFrame]
public void CreateEntity3DPositionAndOrientation()
{
    var position = new Vector3D(10.0f, -3.0f, 27.0f);
    var orientation = Quaternion.Identity;
    var entity = new Entity3D(position, orientation);
    Assert.AreEqual(position, entity.Position);
    Assert.AreEqual(orientation, entity.Orientation);
}

Copy to Clipboard Print

[Test, CloseAfterFirstFrame]
public void SetAndGetEntity3DComponentsDirectly()
{
    var entity = new Entity3D(Vector3D.Zero);
    entity.Set(Vector3D.One);
    Assert.AreEqual(Vector3D.One, entity.Get<Vector3D>());
    entity.Set(Quaternion.Identity);
    Assert.AreEqual(Quaternion.Identity, entity.Get<Quaternion>());
}

[Test, CloseAfterFirstFrame]
public void SetAndGetEntity3DComponentsDirectly()
{
    var entity = new Entity3D(Vector3D.Zero);
    entity.Set(Vector3D.One);
    Assert.AreEqual(Vector3D.One, entity.Get<Vector3D>());
    entity.Set(Quaternion.Identity);
    Assert.AreEqual(Quaternion.Identity, entity.Get<Quaternion>());
}