fCraft.Drawing.CloudyBrush Class Reference

Brush that uses 3D perlin noise to create "cloudy" patterns. More...

Inheritance diagram for fCraft.Drawing.CloudyBrush:

Collaboration diagram for fCraft.Drawing.CloudyBrush:

Public Member Functions
	CloudyBrush ()
	CloudyBrush (Block oneBlock, int ratio)
	CloudyBrush (Block[] blocks, int[] ratios)
	CloudyBrush (CloudyBrush other)
bool	Begin (Player player, DrawOperation op)
Block	NextBlock (DrawOperation op)
IBrushInstance	MakeInstance (Player player, CommandReader cmd, DrawOperation state)
void	End ()
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.
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.

Static Public Member Functions
static UInt16	NextSeed ()

Public Attributes
const int	MaxRatio = 10000
const float	PersistenceDefault = 0.75f

Properties
UInt16	Seed [get, set]
float	Frequency [get, set]
int	Octaves [get, set]
float	Persistence [get, set]
Block[]	Blocks [get, set]
int[]	BlockRatios [get, set]
IBrushFactory	Factory [get]
string	Description [get]
int	AlternateBlocks [get]
IBrush	Brush [get]
string	InstanceDescription [get]
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.
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).

Detailed Description

Brush that uses 3D perlin noise to create "cloudy" patterns.

Constructor & Destructor Documentation

fCraft.Drawing.CloudyBrush.CloudyBrush

(

)

fCraft.Drawing.CloudyBrush.CloudyBrush	(	Block	oneBlock,
		int	ratio
	)

fCraft.Drawing.CloudyBrush.CloudyBrush	(	Block[]	blocks,
		int[]	ratios
	)

fCraft.Drawing.CloudyBrush.CloudyBrush

(

CloudyBrush

other

)

Member Function Documentation

bool fCraft.Drawing.CloudyBrush.Begin	(	Player	player,
		DrawOperation	op
	)

void fCraft.Drawing.CloudyBrush.End

(

)

IBrushInstance fCraft.Drawing.CloudyBrush.MakeInstance	(	Player	player,
		CommandReader	cmd,
		DrawOperation	state
	)

Block fCraft.Drawing.CloudyBrush.NextBlock

(

DrawOperation

op

)

static UInt16 fCraft.Drawing.CloudyBrush.NextSeed ( )

static

Member Data Documentation

const int fCraft.Drawing.CloudyBrush.MaxRatio = 10000

const float fCraft.Drawing.CloudyBrush.PersistenceDefault = 0.75f

Property Documentation

int fCraft.Drawing.CloudyBrush.AlternateBlocks

get

int [] fCraft.Drawing.CloudyBrush.BlockRatios

getset

Block [] fCraft.Drawing.CloudyBrush.Blocks

getset

IBrush fCraft.Drawing.CloudyBrush.Brush

get

string fCraft.Drawing.CloudyBrush.Description

get

IBrushFactory fCraft.Drawing.CloudyBrush.Factory

get

float fCraft.Drawing.CloudyBrush.Frequency

getset

string fCraft.Drawing.CloudyBrush.InstanceDescription

get

int fCraft.Drawing.CloudyBrush.Octaves

getset

float fCraft.Drawing.CloudyBrush.Persistence

getset

UInt16 fCraft.Drawing.CloudyBrush.Seed

getset

---

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

• fCraft/Drawing/Brushes/CloudyBrush.cs