Komodo Engine
C PROJECT_LOGO=
Komodo.Core.ECS.Components.Drawable2DComponent Class Reference

Abstract class defining all 2D drawable Components. A class derived from Drawable2DComponent will render in a SpriteBatch in a Komodo.Core.ECS.Systems.Render2DSystem. More...

Inheritance diagram for Komodo.Core.ECS.Components.Drawable2DComponent:
Komodo.Core.ECS.Components.Component Komodo.Core.ECS.Components.SpriteComponent Komodo.Core.ECS.Components.TextComponent

Protected Member Functions

 Drawable2DComponent (bool isEnabled=true, Entity parent=null)
 
- Protected Member Functions inherited from Komodo.Core.ECS.Components.Component
 Component (bool isEnabled=true, Entity parent=null)
 

Properties

abstract Vector2 Center [get]
 Center point of the rendered Component. More...
 
abstract float Height [get]
 Height of the rendered Component. More...
 
bool IsBillboard [get, set]
 Flags whether or not to draw the Drawable2DComponent as a billboard in 3D space, always facing the relevant Komodo.Core.ECS.Components.CameraComponent. More...
 
Effect Shader [get, set]
 Shader to use when rendering the Component. If Shader is null, the Komodo.Core.Game.DefaultSpriteShader will be used. More...
 
abstract float Width [get]
 Width of the rendered Component. More...
 
- Properties inherited from Komodo.Core.ECS.Components.Component
GameGame [get]
 Each Component maintains a reference to the Komodo.Core.Game instance. More...
 
Guid ID [get]
 Unique identifier for the Component. More...
 
bool IsEnabled [get, set]
 Enabled Components are managed by their corresponding Komodo.Core.ECS.Systems.ISystem, otherwise the Component is ignored. More...
 
bool IsInitialized [get, set]
 Uninitialized Components are initialized by their corresponding Komodo.Core.ECS.Systems.ISystem, otherwise the Component is initialized on the next Komodo.Core.ECS.Systems.ISystem.Initialize, Komodo.Core.ECS.Systems.ISystem.PreUpdate, or Komodo.Core.ECS.Systems.ISystem.PostUpdate methods. More...
 
Entity Parent [get, set]
 Each Component belongs to a Komodo.Core.ECS.Entities.Entity and maintains a reference to the parent Komodo.Core.ECS.Entities.Entity. More...
 
Vector3 Position [get, set]
 Each Component has a position relative to their Parent. More...
 
Vector3?? WorldPosition [get]
 The sum of Position and the Parent's Komodo.Core.ECS.Entities.Entity.Position, representing the Component's position in world space. More...
 
Vector3?? Rotation [get, set]
 Derived from the Parent's Komodo.Core.ECS.Entities.Entity.Rotation. More...
 
Matrix?? RotationMatrix [get]
 Derived from the Parent's Komodo.Core.ECS.Entities.Entity.RotationMatrix. More...
 
Quaternion?? RotationQuaternion [get]
 Derived from the Parent's Komodo.Core.ECS.Entities.Entity.RotationQuaternion. More...
 
Vector3?? Scale [get, set]
 Derived from the Parent's Komodo.Core.ECS.Entities.Entity.Scale. More...
 

Detailed Description

Abstract class defining all 2D drawable Components. A class derived from Drawable2DComponent will render in a SpriteBatch in a Komodo.Core.ECS.Systems.Render2DSystem.

4

Property Documentation

◆ Center

abstract Vector2 Komodo.Core.ECS.Components.Drawable2DComponent.Center
get

Center point of the rendered Component.

◆ Height

abstract float Komodo.Core.ECS.Components.Drawable2DComponent.Height
get

Height of the rendered Component.

◆ IsBillboard

bool Komodo.Core.ECS.Components.Drawable2DComponent.IsBillboard
getset

Flags whether or not to draw the Drawable2DComponent as a billboard in 3D space, always facing the relevant Komodo.Core.ECS.Components.CameraComponent.

◆ Shader

Effect Komodo.Core.ECS.Components.Drawable2DComponent.Shader
getset

Shader to use when rendering the Component. If Shader is null, the Komodo.Core.Game.DefaultSpriteShader will be used.

◆ Width

abstract float Komodo.Core.ECS.Components.Drawable2DComponent.Width
get

Width of the rendered Component.