载入中...
搜索中...
未找到
Public 类型 | Public 成员函数 | 静态 Public 成员函数 | 所有成员列表
eve::sensing::GridArea类 参考

An integer grid area constraint, kept separate from WorldArea. 更多...

#include <Targeting.h>

Public 类型

enum class  Shape : std::uint8_t { Box2D , Box3D }
 Shape public API. 更多...
 

Public 成员函数

 GridArea ()=default
 Constructs an invalid default grid area.
 
Shape shape () const noexcept
 Returns the area shape.
 
CoordinateSpace space () const noexcept
 Returns the area coordinate space.
 
bool isValid () const noexcept
 Returns whether this area is valid.
 
GridPoint minimum () const noexcept
 Return the inclusive minimum grid corner.
 
GridPoint maximum () const noexcept
 Return the inclusive maximum grid corner.
 
bool contains (GridPoint point) const noexcept
 Tests a grid point without converting coordinate spaces.
 

静态 Public 成员函数

static Result< GridArea > box2D (GridPoint minimum, GridPoint maximum)
 Creates an inclusive 2D grid rectangle.
 
static Result< GridArea > box3D (GridPoint minimum, GridPoint maximum)
 Creates an inclusive 3D grid box.
 

详细描述

An integer grid area constraint, kept separate from WorldArea.

Grid distances and world distances have different units. A grid area must be authored and queried in the same Grid2D or Grid3D space.

在文件 Targeting.h 第 273 行定义.

成员枚举类型说明

◆ Shape

enum class eve::sensing::GridArea::Shape : std::uint8_t
strong

Shape public API.

枚举值
Box2D 
Box3D 

在文件 Targeting.h 第 276 行定义.

构造及析构函数说明

◆ GridArea()

eve::sensing::GridArea::GridArea ( )
default

Constructs an invalid default grid area.

被这些函数引用 box2D() , 以及 box3D().

成员函数说明

◆ box2D()

Result< GridArea > eve::sensing::GridArea::box2D ( GridPoint  minimum,
GridPoint  maximum 
)
static

Creates an inclusive 2D grid rectangle.

在文件 Targeting.cpp 第 221 行定义.

引用了 Box2D, eve::Result< T >::failure(), eve::sensing::Grid2D, GridArea(), maximum(), minimum(), eve::Result< T >::success() , 以及 valid.

◆ box3D()

Result< GridArea > eve::sensing::GridArea::box3D ( GridPoint  minimum,
GridPoint  maximum 
)
static

Creates an inclusive 3D grid box.

在文件 Targeting.cpp 第 227 行定义.

引用了 Box3D, eve::Result< T >::failure(), eve::sensing::Grid3D, GridArea(), maximum(), minimum(), eve::Result< T >::success() , 以及 valid.

◆ contains()

bool eve::sensing::GridArea::contains ( GridPoint  point) const
noexcept

Tests a grid point without converting coordinate spaces.

在文件 Targeting.cpp 第 233 行定义.

引用了 point.

◆ isValid()

bool eve::sensing::GridArea::isValid ( ) const
inlinenoexcept

Returns whether this area is valid.

在文件 Targeting.h 第 290 行定义.

◆ maximum()

GridPoint eve::sensing::GridArea::maximum ( ) const
inlinenoexcept

Return the inclusive maximum grid corner.

在文件 Targeting.h 第 294 行定义.

被这些函数引用 box2D() , 以及 box3D().

◆ minimum()

GridPoint eve::sensing::GridArea::minimum ( ) const
inlinenoexcept

Return the inclusive minimum grid corner.

在文件 Targeting.h 第 292 行定义.

被这些函数引用 box2D() , 以及 box3D().

◆ shape()

Shape eve::sensing::GridArea::shape ( ) const
inlinenoexcept

Returns the area shape.

在文件 Targeting.h 第 286 行定义.

◆ space()

CoordinateSpace eve::sensing::GridArea::space ( ) const
inlinenoexcept

Returns the area coordinate space.

在文件 Targeting.h 第 288 行定义.

该类的文档由以下文件生成: