essentials.Systems.BlockTransfer.AbstractBlockTransfer Class Reference

Class that acts as base class for block transfer algorithms More...

Inheritance diagram for essentials.Systems.BlockTransfer.AbstractBlockTransfer:

Public Member Functions
void	AddPressure (Vector3i pt, float amt)
	Add pressure to a given point More...
Public Member Functions inherited from essentials.Systems.BlockTransfer.IReadonlyTransferSystem
bool	Has (Vector3i pt)

Protected Member Functions
	AbstractBlockTransfer (float createThreshold, float removalThreshold, float maxPressure, float speed)
bool	CanTransferTo (Vector3i pt)
abstract float	GetTransferCoefficient (Vector3i pt)
	Determines whether this instance can transfer to the specified block. More...

Properties
IEnumerable< Vector3i >	Members [get]
	Return all coordinates of points within our domain More...
int	BlockCount [get]
	Gets the number of blocks within the system More...
int	QueueCount [get]
	Gets the number of blocks that need to be simulated on for this iteration More...
float	AveragePressure [get]
	Gets the average of all member's pressure More...
float	MaxPressure [get]
	Gets the max pressure value throughout the system More...
float	MinPressure [get]
	Gets the minimum pressure value throughout the system More...
bool	Sealed [get]
	A system is sealed if the pressure is uniform throughout the system, with minimal variation More...
float this[]	Neighbors [get]
	Gets or sets the pressure value at a given point More...
Properties inherited from essentials.Systems.BlockTransfer.IReadonlyTransferSystem
int	BlockCount [get]
float	AveragePressure [get]
float	MaxPressure [get]
float	MinPressure [get]
bool	Sealed [get]

Detailed Description

Class that acts as base class for block transfer algorithms

Constructor & Destructor Documentation

AbstractBlockTransfer()

essentials.Systems.BlockTransfer.AbstractBlockTransfer.AbstractBlockTransfer ( float  createThreshold, float  removalThreshold, float  maxPressure, float  speed  )

protected

        {
            this._createThreshold = createThreshold;
            this._removalThreshold = removalThreshold;
            this._maxPressure = maxPressure;
            this._speed = speed;
        }

Member Function Documentation

AddPressure()

void essentials.Systems.BlockTransfer.AbstractBlockTransfer.AddPressure	(	Vector3i	pt,
		float	amt
	)

Add pressure to a given point

Parameters

pt	Point.
amt	Amt.

Attribute: pt

+= amt;

        {
            this [pt] += amt;
            _queue.Enqueue (pt);
        }

CanTransferTo()

bool essentials.Systems.BlockTransfer.AbstractBlockTransfer.CanTransferTo ( Vector3i  pt )

protected

        {
            return GetTransferCoefficient(pt) >= TRANSFER_MIN;
        }

GetTransferCoefficient()

abstract float essentials.Systems.BlockTransfer.AbstractBlockTransfer.GetTransferCoefficient ( Vector3i  pt )

protectedpure virtual

Determines whether this instance can transfer to the specified block.

Returns

A number, between 0 and 1, that represents how conductive the block can be. 0 means non-conductive

Parameters

pt

The point

Implemented in essentials.Systems.BlockTransfer.PressureTransferSystem, and essentials.Systems.BlockTransfer.GenericTransferSystem.

Property Documentation

AveragePressure

float essentials.Systems.BlockTransfer.AbstractBlockTransfer.AveragePressure

get

Gets the average of all member's pressure

The average pressure.

BlockCount

int essentials.Systems.BlockTransfer.AbstractBlockTransfer.BlockCount

get

Gets the number of blocks within the system

The block count.

MaxPressure

float essentials.Systems.BlockTransfer.AbstractBlockTransfer.MaxPressure

get

Gets the max pressure value throughout the system

The max pressure.

Members

IEnumerable<Vector3i> essentials.Systems.BlockTransfer.AbstractBlockTransfer.Members

get

Return all coordinates of points within our domain

The members.

MinPressure

float essentials.Systems.BlockTransfer.AbstractBlockTransfer.MinPressure

get

Gets the minimum pressure value throughout the system

The minimum pressure.

Neighbors

float this[] essentials.Systems.BlockTransfer.AbstractBlockTransfer.Neighbors

get

Gets or sets the pressure value at a given point

Parameters

pt

Point.

QueueCount

int essentials.Systems.BlockTransfer.AbstractBlockTransfer.QueueCount

get

Gets the number of blocks that need to be simulated on for this iteration

The queue count.

Sealed

bool essentials.Systems.BlockTransfer.AbstractBlockTransfer.Sealed

get

A system is sealed if the pressure is uniform throughout the system, with minimal variation

true if this instance is sealed; otherwise, false.

---

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

• essentials/Systems/BlockTransfer/AbstractBlockTransfer.cs