sKit  0.0.9
Public Member Functions | List of all members
sKit::structure::BRect Class Reference

#include <BRect.hpp>

Inheritance diagram for sKit::structure::BRect:
sKit::structure::BRectBase< BRect >

Public Member Functions

auto getDimensions () -> Dimensions
 
auto getNumRows () -> unsigned int
 
auto getNumCols () -> unsigned int
 
auto getId () -> glm::vec2
 
auto setDimensions (float x, float y, float width, float height) -> void
 
auto setOrientation (Orientation orientation) -> void
 
- Public Member Functions inherited from sKit::structure::BRectBase< BRect >
 BRectBase ()=default
 
auto subdivide (unsigned int numLevels, glm::vec2 _id={0, 0}, SplitFn splitfn=BRectBase< BRect >::splitfn) -> void
 
auto getLeaves () -> std::vector< std::shared_ptr< BRect >>
 
auto getLeafAt (int x, int y) -> std::optional< std::shared_ptr< BRect >>
 

Additional Inherited Members

- Public Types inherited from sKit::structure::BRectBase< BRect >
enum  Orientation
 
- Public Attributes inherited from sKit::structure::BRectBase< BRect >
std::shared_ptr< BRect > left
 
std::shared_ptr< BRect > right
 
- Static Protected Member Functions inherited from sKit::structure::BRectBase< BRect >
const static float splitfn (unsigned int _level, glm::vec2 _id)
 
- Protected Attributes inherited from sKit::structure::BRectBase< BRect >
Orientation orientation_
 
float x_
 
float y_
 
float width_
 
float height_
 
glm::vec2 id
 
int levels
 
bool vertical
 

Detailed Description

Binary Rectangle. A rectangle that is recursively and evenly subdivided along alternating axes.

Definition at line 15 of file BRect.hpp.

Member Function Documentation

◆ getDimensions()

auto sKit::structure::BRect::getDimensions ( ) -> Dimensions

Definition at line 8 of file BRect.cpp.

◆ getId()

auto sKit::structure::BRect::getId ( ) -> glm::vec2

Definition at line 17 of file BRect.cpp.

◆ getNumCols()

auto sKit::structure::BRect::getNumCols ( ) -> unsigned int
Returns
The number of leaf columns

Definition at line 12 of file BRect.cpp.

◆ getNumRows()

auto sKit::structure::BRect::getNumRows ( ) -> unsigned int
Returns
The number of leaf rows

Definition at line 10 of file BRect.cpp.

◆ setDimensions()

auto sKit::structure::BRect::setDimensions ( float  x,
float  y,
float  width,
float  height 
) -> void

Definition at line 19 of file BRect.cpp.

◆ setOrientation()

auto sKit::structure::BRect::setOrientation ( Orientation  orientation) -> void

Definition at line 26 of file BRect.cpp.

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