C# Class fCraft.Drawing.DrawOperation

Abstract class representing a drawing operation.

Show file Open project: GlennMR/800craft Class Usage Examples

Public Properties

Property	Type	Description
Coords	Vector3I

Protected Properties

Property	Type	Description
UndoState	UndoState

Private Properties

Property	Type	Description
End	void
OnCancellation	void
OnCompletion	void
StartBatch	void
TestForDuplicateModification	void

Public Methods

Method	Description
Begin ( ) : bool
Cancel ( ) : void
DrawBatch ( int maxBlocksToDraw ) : int
Prepare ( [ marks ) : bool

Protected Methods

Method	Description
DrawOneBlock ( ) : bool
DrawOperation ( [ player ) : System
LineEnumerator ( Vector3I a, Vector3I b ) : IEnumerable
RaiseBeganEvent ( DrawOperation op ) : void
RaiseBeginningEvent ( DrawOperation op ) : bool
RaiseEndedEvent ( DrawOperation op ) : void

Private Methods

Method	Description
End ( ) : void
OnCancellation ( ) : void
OnCompletion ( ) : void
StartBatch ( ) : void
TestForDuplicateModification ( ) : void

Method Details

Begin() public method

public Begin ( ) : bool
return	bool

Cancel() public method

public Cancel ( ) : void
return	void

DrawBatch() public abstract method

public abstract DrawBatch ( int maxBlocksToDraw ) : int
maxBlocksToDraw	int
return	int

DrawOneBlock() protected method

protected DrawOneBlock ( ) : bool
return	bool

DrawOperation() protected method

protected DrawOperation ( [ player ) : System
player	[
return	System

LineEnumerator() protected static method

protected static LineEnumerator ( Vector3I a, Vector3I b ) : IEnumerable
a	Vector3I
b	Vector3I
return	IEnumerable

Prepare() public method

public Prepare ( [ marks ) : bool
marks	[
return	bool

RaiseBeganEvent() protected static method

protected static RaiseBeganEvent ( DrawOperation op ) : void
op	DrawOperation
return	void

RaiseBeginningEvent() protected static method

protected static RaiseBeginningEvent ( DrawOperation op ) : bool
op	DrawOperation
return	bool

RaiseEndedEvent() protected static method

protected static RaiseEndedEvent ( DrawOperation op ) : void
op	DrawOperation
return	void

Property Details

Coords public property

Coordinates that are currently being processed.

public Vector3I Coords
return	Vector3I

UndoState protected property

Undo state associated with this operation. Created by DrawOperation.Begin().

protected UndoState,fCraft.Drawing UndoState
return	UndoState