HexMapLibrary
Public Member Functions | Properties | List of all members
Wunderwunsch.HexMapLibrary.Generic.Edge< E > Class Template Reference

generic Edge which can have any object with an parameterless constructor as content More...

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

Public Member Functions

 Edge (Vector3Int position, int index, Vector2 normalizedPosition, bool createDefaultDataObject=true)
 constructor without passing an instance of E in , creating a default instance of E by calling it's parameterless constructor More...
 
 Edge (Vector3Int position, int index, Vector2 normalizedPosition, E data)
 constructor including an instance of E More...
 
- Public Member Functions inherited from Wunderwunsch.HexMapLibrary.Edge
 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

Data [get, set]
 can be any object, defines the actual content of the Edge More...
 
- Properties inherited from Wunderwunsch.HexMapLibrary.Edge
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

generic Edge which can have any object with an parameterless constructor as content

Type Constraints
E :new() 

Constructor & Destructor Documentation

◆ Edge() [1/2]

Wunderwunsch.HexMapLibrary.Generic.Edge< E >.Edge ( Vector3Int  position,
int  index,
Vector2  normalizedPosition,
bool  createDefaultDataObject = true 
)

constructor without passing an instance of E in , creating a default instance of E by calling it's parameterless constructor

◆ Edge() [2/2]

Wunderwunsch.HexMapLibrary.Generic.Edge< E >.Edge ( Vector3Int  position,
int  index,
Vector2  normalizedPosition,
data 
)

constructor including an instance of E

Property Documentation

◆ Data

can be any object, defines the actual content of the Edge