Microsoft.Xna.Framework

Class DrawableGameComponent

java.lang.Object

Microsoft.Xna.Framework.GameComponent

Microsoft.Xna.Framework.DrawableGameComponent

All Implemented Interfaces:

IDrawable, IGameComponent, IUpdateable, System.IDisposable

public class DrawableGameComponent
extends GameComponent
implements IDrawable

A game component that is notified when it needs to draw itself.

Author:

Halofreak1990

Field Summary

Fields

Modifier and Type	Field and Description
System.Event<System.EventArgs>	DrawOrderChanged Raised when the DrawOrder property changes.
System.Event<System.EventArgs>	VisibleChanged Raised when the Visible property changes.

Fields inherited from class Microsoft.Xna.Framework.GameComponent

Disposed, EnabledChanged, UpdateOrderChanged

Constructor Summary

Constructors

Constructor and Description
DrawableGameComponent(Game game) Creates a new instance of DrawableGameComponent.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	Dispose(boolean disposing) Releases the unmanaged resources used by the DrawableGameComponent and optionally releases the managed resources.
void	Draw(GameTime gameTime) Called when the DrawableGameComponent needs to be drawn.
int	getDrawOrder() Order in which the component should be drawn, relative to other components that are in the same GameComponentCollection.
Microsoft.Xna.Framework.Graphics.GraphicsDevice	getGraphicsDevice() The GraphicsDevice the DrawableGameComponent is associated with.
boolean	getVisible() Indicates whether Draw should be called.
void	Initialize() Initializes the component.
protected void	LoadContent() Called when graphics resources need to be loaded.
protected void	OnDrawOrderChanged(java.lang.Object sender, System.EventArgs e) Called when the DrawOrder property changes.
protected void	OnVisibleChanged(java.lang.Object sender, System.EventArgs e) Called when the Visible property changes.
void	setDrawOrder(int value)
void	setVisible(boolean value)
protected void	UnloadContent() Called when graphics resources need to be unloaded.

Methods inherited from class Microsoft.Xna.Framework.GameComponent

Dispose, getEnabled, getGame, getUpdateOrder, OnEnabledChanged, OnUpdateOrderChanged, setEnabled, setUpdateOrder, Update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DrawOrderChanged

public final System.Event<System.EventArgs> DrawOrderChanged

Raised when the DrawOrder property changes.

VisibleChanged

public final System.Event<System.EventArgs> VisibleChanged

Raised when the Visible property changes.

Constructor Detail

DrawableGameComponent

public DrawableGameComponent(Game game)

Creates a new instance of DrawableGameComponent.

Parameters:

game - The Game that the game component should be attached to.

Method Detail

getDrawOrder

public int getDrawOrder()

Order in which the component should be drawn, relative to other components that are in the same GameComponentCollection.

Specified by:

getDrawOrder in interface IDrawable

setDrawOrder

public void setDrawOrder(int value)

getGraphicsDevice

public Microsoft.Xna.Framework.Graphics.GraphicsDevice getGraphicsDevice()

The GraphicsDevice the DrawableGameComponent is associated with.

getVisible

public boolean getVisible()

Indicates whether Draw should be called.

Specified by:

getVisible in interface IDrawable

setVisible

public void setVisible(boolean value)

Dispose

protected void Dispose(boolean disposing)

Releases the unmanaged resources used by the DrawableGameComponent and optionally releases the managed resources.

Overrides:

Dispose in class GameComponent

Parameters:

disposing - true to release both managed and unmanaged resources; false to release only unmanaged resources.

Initialize

public void Initialize()

Initializes the component. Override this method to load any non-graphics resources and query for any required services.

Specified by:

Initialize in interface IGameComponent

Overrides:

Initialize in class GameComponent

LoadContent

protected void LoadContent()

Called when graphics resources need to be loaded. Override this method to load any component-specific graphics resources.

OnDrawOrderChanged

protected void OnDrawOrderChanged(java.lang.Object sender,
                      System.EventArgs e)

Called when the DrawOrder property changes. Raises the DrawOrderChanged event.

Parameters:

sender - The DrawableGameComponent.

e - Arguments to the DrawOrderChanged event.

OnVisibleChanged

protected void OnVisibleChanged(java.lang.Object sender,
                    System.EventArgs e)

Called when the Visible property changes. Raises the VisibleChanged event.

Parameters:

sender - The DrawableGameComponent.

e - Arguments to the DrawOrderChanged event.

UnloadContent

protected void UnloadContent()

Called when graphics resources need to be unloaded. Override this method to unload any component-specific graphics resources.

Draw

public void Draw(GameTime gameTime)

Called when the DrawableGameComponent needs to be drawn. Override this method with component-specific drawing code.

Specified by:

Draw in interface IDrawable

Parameters:

gameTime - Time passed since the last call to Draw.