AlphaFramework API  1.0.3
Public Member Functions | Static Public Member Functions | Properties | List of all members
AlphaFramework.World.Terrains.TerrainSize Struct Reference

Contains information about the size of a ITerrain. More...

Public Member Functions

 TerrainSize (int x, int y, float stretchH=1, float stretchV=1)
 Creates a new ITerrain point information struct. More...
 
override string ToString ()
 

Static Public Member Functions

static implicit operator TerrainSize (Size size)
 Convert Size into TerrainSize. More...
 
static implicit operator Size (TerrainSize size)
 Convert TerrainSize into Size. More...
 

Properties

int X [get, set]
 The size of the ITerrain along the X-axis. More...
 
int Y [get, set]
 The size of the ITerrain along the Y-axis. More...
 
float StretchH [get, set]
 A factor by which the ITerrain is horizontally stretched. More...
 
float StretchV [get, set]
 A factor by which the ITerrain is vertically stretched. More...
 

Detailed Description

Contains information about the size of a ITerrain.

See also
ITerrain.Size

Constructor & Destructor Documentation

◆ TerrainSize()

AlphaFramework.World.Terrains.TerrainSize.TerrainSize ( int  x,
int  y,
float  stretchH = 1,
float  stretchV = 1 
)
inline

Creates a new ITerrain point information struct.

Parameters
xThe size along the x-axis.
yThe size along the y-axis.
stretchHA factor by which the terrain is horizontally stretched.
stretchVA factor by which the terrain is vertically stretched.

Member Function Documentation

◆ operator Size()

static implicit AlphaFramework.World.Terrains.TerrainSize.operator Size ( TerrainSize  size)
inlinestatic

Convert TerrainSize into Size.

◆ operator TerrainSize()

static implicit AlphaFramework.World.Terrains.TerrainSize.operator TerrainSize ( Size  size)
inlinestatic

Convert Size into TerrainSize.

Property Documentation

◆ StretchH

float AlphaFramework.World.Terrains.TerrainSize.StretchH
getset

A factor by which the ITerrain is horizontally stretched.

◆ StretchV

float AlphaFramework.World.Terrains.TerrainSize.StretchV
getset

A factor by which the ITerrain is vertically stretched.

◆ X

int AlphaFramework.World.Terrains.TerrainSize.X
getset

The size of the ITerrain along the X-axis.

◆ Y

int AlphaFramework.World.Terrains.TerrainSize.Y
getset

The size of the ITerrain along the Y-axis.


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