Drag[en]gine Script Module DragonScript Script API  1.0
NavigationSpace Class Reference

Navigation space. More...

Inheritance diagram for NavigationSpace:

Public Member Functions

Constructors
NavigationSpace new ()
 Create navigation space. More...
 
Management
DVector getPosition ()
 Position. More...
 
void setPosition (DVector position)
 Set position. More...
 
Quaternion getOrientation ()
 Orientation. More...
 
void setOrientation (Orientation orientation)
 Set orientation. More...
 
int getLayer ()
 Layer number. More...
 
void setLayer (int layer)
 Set layer number. More...
 
int getType ()
 Space type. More...
 
void setType (int type)
 Set space type. More...
 
int getBlockingPriority ()
 Blocking priority. More...
 
void setBlockingPriority (int priority)
 Set blocking priority. More...
 
float getSnapDistance ()
 Snap distance in meters up to which edges are linked to neighbor spaces. More...
 
void setSnapDistance (float distance)
 Set snap distance in meters up to which edges are linked to neighbor spaces. More...
 
float getSnapAngle ()
 Snap angle in degrees up to which edges are linked to neighbor spaces. More...
 
void setSnapAngle (float angle)
 Set snap angle in degrees up to which edges are linked to neighbor spaces. More...
 
void layoutChanged ()
 Notifies the peers that the layout of the navigation space changed. More...
 
ShapeList getBlockerShapeList ()
 Blocker shape list. More...
 
void setBlockerShapeList (ShapeList shapeList)
 Set blocker shape list. More...
 
Vertices (grid, space, volume)
int getVertexCount ()
 Number of vertices.. More...
 
void setVertexCount (int count)
 Set number of vertices. More...
 
Vector getVertexAt (int index)
 Vertex at index. More...
 
void setVertexAt (int index, Vector position)
 Set vertex at index. More...
 
Edges (grid, space, volume)
int getEdgeCount ()
 Number of edges. More...
 
void setEdgeCount (int count)
 Set number of edges. More...
 
int getEdgeVertex1 (int edge)
 Index of the first vertex of edge at index. More...
 
int getEdgeVertex2 (int edge)
 Index of the second vertex of edge at index. More...
 
int getEdgeType1 (int edge)
 Type number to use for the edge at position crossing the edge from the first to the second vertex. More...
 
int getEdgeType2 (int edge)
 Type number to use for the edge at position crossing the edge from the second to the first vertex. More...
 
void setEdgeAt (int edge, int vertex1, int vertex2, int type1, int type2)
 Set parameters for edge at index. More...
 
Corners (space, volume)
int getCornerCount ()
 Number of corners. More...
 
void setCornerCount (int count)
 Set number of corners. More...
 
int getCornerVertex (int corner)
 Index of the vertex for corner at index. More...
 
int getCornerType (int corner)
 Type number for corner at position used when crossing the edge from the parent face to the other face. More...
 
void setCornerAt (int corner, int vertex, int type)
 Set parameters of corner at index. More...
 
Faces (space, volume)
int getFaceCount ()
 Number of faces. More...
 
void setFaceCount (int count)
 Set number of faces. More...
 
int getFaceCornerCount (int face)
 Number of corners for face at index. More...
 
int getFaceType (int face)
 Type number to use while crossing face at index. More...
 
void setFaceAt (int face, int cornerCount, int type)
 Set parameters of face at index. More...
 
Walls (volume)
int getWallCount ()
 Number of walls. More...
 
void setWallCount (int count)
 Set number of walls. More...
 
int getWallFace (int wall)
 Index of face for wall at index. More...
 
int getWallType (int wall)
 Type number to use for crossing wall at index. More...
 
void setWallAt (int wall, int face, int type)
 Set parameters for wall at index. More...
 
Rooms (volume)
int getRoomCount ()
 Number of rooms. More...
 
void setRoomCount (int count)
 Set number of rooms. More...
 
int getRoomFrontWallCount (int room)
 Number of front facing walls in room at index. More...
 
int getRoomBackWallCount (int room)
 Number of back facing walls in room at index. More...
 
int getRoomType ()
 Type number to use for crossing room at index. More...
 
void setRoomAt (int room, int frontWallCount, int backWallCount, int type)
 Set parameters for room at index. More...
 

Detailed Description

Navigation space.

This is a native class.

Author
Roland Plüss
Version
1.0
Date
2015

Member Function Documentation

§ getBlockerShapeList()

ShapeList getBlockerShapeList ( )

Blocker shape list.

§ getBlockingPriority()

int getBlockingPriority ( )

Blocking priority.

Navigation meshes is blocked by all blockers with an equal or larger blocking priority. If a blocker shape exists it blocks all navigation meshes with equal or less blocking priority.

§ getCornerCount()

int getCornerCount ( )

Number of corners.

§ getCornerType()

int getCornerType ( int  corner)

Type number for corner at position used when crossing the edge from the parent face to the other face.

§ getCornerVertex()

int getCornerVertex ( int  corner)

Index of the vertex for corner at index.

§ getEdgeCount()

int getEdgeCount ( )

Number of edges.

§ getEdgeType1()

int getEdgeType1 ( int  edge)

Type number to use for the edge at position crossing the edge from the first to the second vertex.

§ getEdgeType2()

int getEdgeType2 ( int  edge)

Type number to use for the edge at position crossing the edge from the second to the first vertex.

§ getEdgeVertex1()

int getEdgeVertex1 ( int  edge)

Index of the first vertex of edge at index.

§ getEdgeVertex2()

int getEdgeVertex2 ( int  edge)

Index of the second vertex of edge at index.

§ getFaceCornerCount()

int getFaceCornerCount ( int  face)

Number of corners for face at index.

§ getFaceCount()

int getFaceCount ( )

Number of faces.

§ getFaceType()

int getFaceType ( int  face)

Type number to use while crossing face at index.

§ getLayer()

int getLayer ( )

Layer number.

§ getOrientation()

Quaternion getOrientation ( )

Orientation.

§ getPosition()

DVector getPosition ( )

Position.

§ getRoomBackWallCount()

int getRoomBackWallCount ( int  room)

Number of back facing walls in room at index.

§ getRoomCount()

int getRoomCount ( )

Number of rooms.

§ getRoomFrontWallCount()

int getRoomFrontWallCount ( int  room)

Number of front facing walls in room at index.

§ getRoomType()

int getRoomType ( )

Type number to use for crossing room at index.

§ getSnapAngle()

float getSnapAngle ( )

Snap angle in degrees up to which edges are linked to neighbor spaces.

The default snap angle is 180°.

§ getSnapDistance()

float getSnapDistance ( )

Snap distance in meters up to which edges are linked to neighbor spaces.

The default snap distance is 0.001 (1mm).

§ getType()

int getType ( )

Space type.

§ getVertexAt()

Vector getVertexAt ( int  index)

Vertex at index.

§ getVertexCount()

int getVertexCount ( )

Number of vertices..

§ getWallCount()

int getWallCount ( )

Number of walls.

§ getWallFace()

int getWallFace ( int  wall)

Index of face for wall at index.

§ getWallType()

int getWallType ( int  wall)

Type number to use for crossing wall at index.

§ layoutChanged()

void layoutChanged ( )

Notifies the peers that the layout of the navigation space changed.

This has to be called after changes made to vertices or faces

§ new()

NavigationSpace new ( )

Create navigation space.

§ setBlockerShapeList()

void setBlockerShapeList ( ShapeList  shapeList)

Set blocker shape list.

§ setBlockingPriority()

void setBlockingPriority ( int  priority)

Set blocking priority.

Navigation meshes is blocked by all blockers with an equal or larger blocking priority. If a blocker shape exists it blocks all navigation meshes with equal or less blocking priority.

§ setCornerAt()

void setCornerAt ( int  corner,
int  vertex,
int  type 
)

Set parameters of corner at index.

§ setCornerCount()

void setCornerCount ( int  count)

Set number of corners.

§ setEdgeAt()

void setEdgeAt ( int  edge,
int  vertex1,
int  vertex2,
int  type1,
int  type2 
)

Set parameters for edge at index.

§ setEdgeCount()

void setEdgeCount ( int  count)

Set number of edges.

§ setFaceAt()

void setFaceAt ( int  face,
int  cornerCount,
int  type 
)

Set parameters of face at index.

§ setFaceCount()

void setFaceCount ( int  count)

Set number of faces.

§ setLayer()

void setLayer ( int  layer)

Set layer number.

§ setOrientation()

void setOrientation ( Orientation  orientation)

Set orientation.

§ setPosition()

void setPosition ( DVector  position)

Set position.

§ setRoomAt()

void setRoomAt ( int  room,
int  frontWallCount,
int  backWallCount,
int  type 
)

Set parameters for room at index.

§ setRoomCount()

void setRoomCount ( int  count)

Set number of rooms.

§ setSnapAngle()

void setSnapAngle ( float  angle)

Set snap angle in degrees up to which edges are linked to neighbor spaces.

The default snap angle is 180°.

§ setSnapDistance()

void setSnapDistance ( float  distance)

Set snap distance in meters up to which edges are linked to neighbor spaces.

The default snap distance is 0.001 (1mm).

§ setType()

void setType ( int  type)

Set space type.

§ setVertexAt()

void setVertexAt ( int  index,
Vector  position 
)

Set vertex at index.

§ setVertexCount()

void setVertexCount ( int  count)

Set number of vertices.

§ setWallAt()

void setWallAt ( int  wall,
int  face,
int  type 
)

Set parameters for wall at index.

§ setWallCount()

void setWallCount ( int  count)

Set number of walls.


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