Agents.ImageFlowField Class Reference

Flow field based on a texture. More...

Inheritance diagram for Agents.ImageFlowField:

Public Member Functions
	ImageFlowField ()
	Create a new image flow field More...
Public Member Functions inherited from Agents.SimpleFlowField
Vector2	Lookup (Vector2 position)
	Lookup direction from flow. More...

Public Attributes
Texture	SourceTexture
	Source texture More...
bool	CenterOnScreen
	Center on screen More...
Public Attributes inherited from Agents.SimpleFlowField
int	Resolution = 30
	Grid resolution More...

Protected Member Functions
void	CreateFieldFromTexture ()
	Create field from source texture. More...
Vector2	ColorToDirection (Color color)
	Convert color to direction. More...
override Vector2	ComputeDirectionFromPosition (int x, int y)
	Compute flow direction from a given position. Defaults with a right vector. More...
Protected Member Functions inherited from Agents.SimpleFlowField
void	RefreshDirections ()
	Refresh flow directions. More...

Properties
int	TextureScale = 1 [get, set]
	Texture scale More...

Additional Inherited Members
Protected Attributes inherited from Agents.SimpleFlowField
int	cols
	Column count More...
int	rows
	Row count More...
FlowDirection[]	field
	Flow field More...
Vector2	size
	Size More...

Detailed Description

Flow field based on a texture.

Definition at line 8 of file ImageFlowField.cs.

Constructor & Destructor Documentation

ImageFlowField()

Agents.ImageFlowField.ImageFlowField ( )

inline

Create a new image flow field

Definition at line 22 of file ImageFlowField.cs.

        {
            _sprite = new Sprite();
        }

Member Function Documentation

ColorToDirection()

Vector2 Agents.ImageFlowField.ColorToDirection ( Color  color )

inlineprotected

Convert color to direction.

Parameters

color

Color

Returns

Direction

Definition at line 63 of file ImageFlowField.cs.

        {
            // Use red component as a reference.
            var angle = MathUtils.Map(color.r, 0, 1, 0, Mathf.Pi / 2);
            return new Vector2(Mathf.Cos(angle), Mathf.Sin(angle));
        }

ComputeDirectionFromPosition()

override Vector2 Agents.ImageFlowField.ComputeDirectionFromPosition ( int  x, int  y  )

inlineprotectedvirtual

Compute flow direction from a given position. Defaults with a right vector.

Parameters

x	X coordinate
y	Y coordinate

Returns

Flow direction

Reimplemented from Agents.SimpleFlowField.

Definition at line 70 of file ImageFlowField.cs.

        {
            var res = Resolution / TextureScale;
            var image = SourceTexture.GetData();
            image.Lock();
            // Get middle pixel
            var color = image.GetPixel((x * res) + (res / 2), (y * res) + (res / 2));
            image.Unlock();
            return ColorToDirection(color);
        }

CreateFieldFromTexture()

void Agents.ImageFlowField.CreateFieldFromTexture ( )

inlineprotected

Create field from source texture.

Definition at line 30 of file ImageFlowField.cs.

        {
            var texSize = SourceTexture.GetSize() * TextureScale;
            var resolutionSize = new Vector2(Resolution, Resolution);
            size = texSize;
            cols = (int)(texSize.x / Resolution);
            rows = (int)(texSize.y / Resolution);
            field = new FlowDirection[cols * rows];
 
            for (int j = 0; j < rows; ++j)
            {
                for (int i = 0; i < cols; ++i)
                {
                    var idx = i + (j * cols);
                    var direction = new FlowDirection()
                    {
                        RectSize = resolutionSize,
                        RectPosition = new Vector2(i * Resolution, j * Resolution),
                        RectPivotOffset = resolutionSize / 2.0f,
                        Direction = ComputeDirectionFromPosition(i, j),
                    };
                    direction.RectRotation = Mathf.Rad2Deg(direction.Direction.Angle());
                    field[idx] = direction;
                    AddChild(direction);
                }
            }
        }

Member Data Documentation

CenterOnScreen

bool Agents.ImageFlowField.CenterOnScreen

Center on screen

Definition at line 17 of file ImageFlowField.cs.

SourceTexture

Texture Agents.ImageFlowField.SourceTexture

Source texture

Definition at line 11 of file ImageFlowField.cs.

Property Documentation

TextureScale

int Agents.ImageFlowField.TextureScale = 1

getset

Texture scale

Definition at line 14 of file ImageFlowField.cs.

{ get; set; } = 1;

---

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

• scripts/agents/ImageFlowField.cs