C# Class FSO.Vitaboy.Avatar

The base class for all avatars in the game.

Inheritance: FSO.Common.Rendering.Framework._3DComponent

Show file Open project: RHY3756547/FreeSO Class Usage Examples

Public Properties

Property	Type	Description
Bindings	List
Effect	Microsoft.Xna.Framework.Graphics.Effect

Public Methods

Method	Description
AddAccessory ( Appearance apr ) : void	Adds an accessory to this avatar.
Avatar ( Avatar old ) : System
Avatar ( Skeleton skel ) : System	Creates a new Avatar instance.
DeviceReset ( GraphicsDevice Device ) : void
Draw ( Microsoft device ) : void	Draws the meshes making up this Avatar instance.
DrawGeometry ( Microsoft device, Effect effect ) : void
Initialize ( ) : void	Initializes this Avatar instance.
ReloadSkeleton ( ) : void	When the skeleton changes (for example due to an animation) this method will recompute the meshes to adhere to the new skeleton positions.
RemoveAccessory ( Appearance apr ) : void	Remove an accessory from this avatar.
RemoveAppearance ( AvatarAppearanceInstance appearance, bool dispose ) : void	Removes an Appearance instance from this avatar.
StoreOnGPU ( GraphicsDevice device ) : void
Update ( FSO state ) : void	Updates this Avatar instance.
setVitaboyEffect ( Effect e ) : void

Protected Methods

Method	Description
AddAppearance ( Appearance appearance ) : AvatarAppearanceInstance	Adds an Appearance instance to this avatar.
AddBinding ( Binding binding ) : AvatarBindingInstance	Adds a Binding instance to this avatar.
RemoveBinding ( AvatarBindingInstance instance, bool dispose ) : void	Removes a Binding instance from this avatar.

Method Details

AddAccessory() public method

Adds an accessory to this avatar.

public AddAccessory ( Appearance apr ) : void
apr	Appearance	The Appearance instance of the accessory.
return	void

AddAppearance() protected method

Adds an Appearance instance to this avatar.

protected AddAppearance ( Appearance appearance ) : AvatarAppearanceInstance
appearance	Appearance	The Appearance instance to add.
return	AvatarAppearanceInstance

AddBinding() protected method

Adds a Binding instance to this avatar.

protected AddBinding ( Binding binding ) : AvatarBindingInstance
binding	Binding	The Binding instance to add.
return	AvatarBindingInstance

Avatar() public method

public Avatar ( Avatar old ) : System
old	Avatar
return	System

Avatar() public method

Creates a new Avatar instance.

public Avatar ( Skeleton skel ) : System
skel	Skeleton	A Skeleton instance.
return	System

DeviceReset() public method

public DeviceReset ( GraphicsDevice Device ) : void
Device	GraphicsDevice
return	void

Draw() public method

Draws the meshes making up this Avatar instance.

public Draw ( Microsoft device ) : void
device	Microsoft	A GraphicsDevice instance.
return	void

DrawGeometry() public method

public DrawGeometry ( Microsoft device, Effect effect ) : void
device	Microsoft
effect	Microsoft.Xna.Framework.Graphics.Effect
return	void

Initialize() public method

Initializes this Avatar instance.

public Initialize ( ) : void
return	void

ReloadSkeleton() public method

When the skeleton changes (for example due to an animation) this method will recompute the meshes to adhere to the new skeleton positions.

public ReloadSkeleton ( ) : void
return	void

RemoveAccessory() public method

Remove an accessory from this avatar.

public RemoveAccessory ( Appearance apr ) : void
apr	Appearance	The Appearance of the accessory to remove.
return	void

RemoveAppearance() public method

Removes an Appearance instance from this avatar.

public RemoveAppearance ( AvatarAppearanceInstance appearance, bool dispose ) : void
appearance	AvatarAppearanceInstance	The Appearance instance to remove.
dispose	bool	Should the appearance be disposed?
return	void

RemoveBinding() protected method

Removes a Binding instance from this avatar.

protected RemoveBinding ( AvatarBindingInstance instance, bool dispose ) : void
instance	AvatarBindingInstance	The Binding instance to remove.
dispose	bool	Should the binding be disposed?
return	void

StoreOnGPU() public method

public StoreOnGPU ( GraphicsDevice device ) : void
device	GraphicsDevice
return	void

Update() public method

Updates this Avatar instance.

public Update ( FSO state ) : void
state	FSO	An UpdateState instance.
return	void

setVitaboyEffect() public static method

public static setVitaboyEffect ( Effect e ) : void
e	Microsoft.Xna.Framework.Graphics.Effect
return	void

Property Details

Bindings public property

public List Bindings
return	List

Effect public static property

public static Effect,Microsoft.Xna.Framework.Graphics Effect
return	Microsoft.Xna.Framework.Graphics.Effect