HexMapLibrary
Public Member Functions | Properties | List of all members
Wunderwunsch.HexMapLibrary.Edge Class Reference

non-generic base class for an edge containing positional data, either use generic version or extend from this class for your own implementation More...

Inheritance diagram for Wunderwunsch.HexMapLibrary.Edge:
Wunderwunsch.HexMapLibrary.MapElement Wunderwunsch.HexMapLibrary.Generic.Edge< E >

Public Member Functions

 Edge (Vector3Int position, int index, Vector2 normalizedPosition)
 Initializes a new Edge instance More...
 
- Public Member Functions inherited from Wunderwunsch.HexMapLibrary.MapElement
override string ToString ()
 returns a string with 3 Lines, one each for Index, Position and NormalizedPosition More...
 

Properties

override Vector3 CartesianPosition [get]
 returns the cartesian coordinate of the edge midpoint More...
 
EdgeAlignment EdgeAlignment [get, private set]
 the edge is parallel to this axis More...
 
float EdgeAlignmentAngle [get]
 the rotationAngle of the edge depending on EdgeOrientation, More...
 
- Properties inherited from Wunderwunsch.HexMapLibrary.MapElement
int Index [get, private set]
 index of the MapElement, HexMap.Tiles , HexMap.Edges and HexMap.Corners arrays are mapped based on this. Can be arbitrarily chosen as long as it starts with 0 and has no gaps. More...
 
Vector3Int Position [get, private set]
 coordinate of the MapElement More...
 
abstract Vector3 CartesianPosition [get]
 returns the cartesian coordinate of the MapElement More...
 
Vector2 NormalizedPosition [get, private set]
 position normalised to a range of [0...1] based on the boundingbox of the map tiles,edges or corners More...
 

Additional Inherited Members

- Protected Member Functions inherited from Wunderwunsch.HexMapLibrary.MapElement
 MapElement (Vector3Int position, int index, Vector2 normalizedPosition)
 base constructor called by derived classes of MapElement More...
 

Detailed Description

non-generic base class for an edge containing positional data, either use generic version or extend from this class for your own implementation

Constructor & Destructor Documentation

◆ Edge()

Wunderwunsch.HexMapLibrary.Edge.Edge ( Vector3Int  position,
int  index,
Vector2  normalizedPosition 
)

Initializes a new Edge instance

>

Property Documentation

◆ CartesianPosition

override Vector3 Wunderwunsch.HexMapLibrary.Edge.CartesianPosition
get

returns the cartesian coordinate of the edge midpoint

◆ EdgeAlignment

EdgeAlignment Wunderwunsch.HexMapLibrary.Edge.EdgeAlignment
getprivate set

the edge is parallel to this axis

◆ EdgeAlignmentAngle

float Wunderwunsch.HexMapLibrary.Edge.EdgeAlignmentAngle
get

the rotationAngle of the edge depending on EdgeOrientation,