Brush that alternates between two block types, in a checkered pattern. More...

Inheritance diagram for fCraft.Drawing.CheckeredBrush:

Collaboration diagram for fCraft.Drawing.CheckeredBrush:

Public Member Functions
	CheckeredBrush (Block block1, Block block2)

	CheckeredBrush ([NotNull] CheckeredBrush other)

IBrushInstance	MakeInstance (Player player, CommandReader cmd, DrawOperation op)

bool	Begin (Player player, DrawOperation state)

Block	NextBlock (DrawOperation state)

void	End ()

Public Member Functions inherited from fCraft.Drawing.IBrushInstance
bool	Begin ([NotNull] Player player,[NotNull] DrawOperation op)
	Called when the DrawOperation starts. Should be used to verify that the brush is ready for use. Resources used by the brush should be obtained here.

Block	NextBlock ([NotNull] DrawOperation op)
	Provides the next Block type for the given DrawOperation.

void	End ()
	Called when the DrawOperation is done or cancelled. Resources used by the brush should be freed/disposed here.

Public Member Functions inherited from fCraft.Drawing.IBrush
IBrushInstance	MakeInstance ([NotNull] Player player,[NotNull] CommandReader cmd,[NotNull] DrawOperation op)
	Creates an instance for this configured brush, for use with a specific DrawOperation.

Properties
Block	Block1 `[get, set]`

Block	Block2 `[get, set]`

IBrushFactory	Factory `[get]`

string	Description `[get]`

IBrush	Brush `[get]`

int	AlternateBlocks `[get]`

string	InstanceDescription `[get]`

Properties inherited from fCraft.Drawing.IBrushInstance
IBrush	Brush `[get]`
	Configured brush that created this instance.

string	InstanceDescription `[get]`
	A compact readable summary of brush type, configuration, and state.

int	AlternateBlocks `[get]`
	Whether the brush is capable of providing alternate blocks (e.g. for filling hollow DrawOps).

Properties inherited from fCraft.Drawing.IBrush
IBrushFactory	Factory `[get]`
	IBrushFactory associated with this brush type.

string	Description `[get]`
	A compact readable summary of brush type and configuration.

Detailed Description

Brush that alternates between two block types, in a checkered pattern.

Constructor & Destructor Documentation

fCraft.Drawing.CheckeredBrush.CheckeredBrush	(	Block	block1,
		Block	block2
	)

fCraft.Drawing.CheckeredBrush.CheckeredBrush ( [NotNull] CheckeredBrush other )

bool fCraft.Drawing.CheckeredBrush.Begin	(	Player	player,
		DrawOperation	state
	)

void fCraft.Drawing.CheckeredBrush.End ( )

IBrushInstance fCraft.Drawing.CheckeredBrush.MakeInstance	(	Player	player,
		CommandReader	cmd,
		DrawOperation	op
	)

Block fCraft.Drawing.CheckeredBrush.NextBlock ( DrawOperation state )

int fCraft.Drawing.CheckeredBrush.AlternateBlocks

get

Block fCraft.Drawing.CheckeredBrush.Block1

getset

Block fCraft.Drawing.CheckeredBrush.Block2

getset

IBrush fCraft.Drawing.CheckeredBrush.Brush

get

string fCraft.Drawing.CheckeredBrush.Description

get

IBrushFactory fCraft.Drawing.CheckeredBrush.Factory

get

string fCraft.Drawing.CheckeredBrush.InstanceDescription

get

The documentation for this class was generated from the following file: