Lexis  1.2.0
Vocabulary of events and shared objects for BBP and HBP software
lexis::render::ClipPlanes Class Reference
+ Inheritance diagram for lexis::render::ClipPlanes:
+ Collaboration diagram for lexis::render::ClipPlanes:

Public Member Functions

 ClipPlanes ()
 Adds 6 othogonal planes in normalized space (+x,-x,+y,-y,+z,-z). More...
 
bool isEmpty () const
 
void clear ()
 Clears all planes, results in isEmpty() == true. More...
 
void reset ()
 Reset to planes setup by constructor. More...
 
bool isOutside (const vmml::AABBf &box) const
 
- Public Member Functions inherited from lexis::render::detail::ClipPlanes
ClipPlanes::Planes & getPlanes ()
 Get a reference to the Planes dynamic member. More...
 
const ClipPlanes::Planes & getPlanes () const
 
std::vector< PlanegetPlanesVector () const
 
void setPlanes (const std::vector< Plane > &value)
 Set the value of Planes dynamic array from a std::vector< Plane >. More...
 
void compact (float threshold=0.1f) final
 
 ClipPlanes (const std::vector< Plane > &planesValue)
 
 ClipPlanes (const ClipPlanes &rhs)
 
 ClipPlanes (ClipPlanes &&rhs) noexcept
 
 ClipPlanes (const ::zerobuf::Zerobuf &rhs)
 
 ClipPlanes (::zerobuf::AllocatorPtr allocator)
 
ClipPlanesoperator= (const ClipPlanes &rhs)
 
ClipPlanesoperator= (ClipPlanes &&rhs)
 
std::string getSchema () const final
 
std::string getTypeName () const final
 
::zerobuf::uint128_t getTypeIdentifier () const final
 
size_t getZerobufStaticSize () const final
 
size_t getZerobufNumDynamics () const final
 
void _parseJSON (const Json::Value &json) final
 
void _createJSON (Json::Value &json) const final
 

Additional Inherited Members

- Public Types inherited from lexis::render::detail::ClipPlanes
typedef ::zerobuf::Vector< PlanePlanes
 
- Static Public Member Functions inherited from lexis::render::detail::ClipPlanes
static std::string ZEROBUF_SCHEMA ()
 
static std::string ZEROBUF_TYPE_NAME ()
 
::zerobuf::uint128_t ZEROBUF_TYPE_IDENTIFIER ()
 
static size_t ZEROBUF_STATIC_SIZE ()
 
static size_t ZEROBUF_NUM_DYNAMICS ()
 
static ConstClipPlanesPtr create (const void *data, const size_t size)
 

Detailed Description

Definition at line 16 of file ClipPlanes.h.

Constructor & Destructor Documentation

lexis::render::ClipPlanes::ClipPlanes ( )

Adds 6 othogonal planes in normalized space (+x,-x,+y,-y,+z,-z).

Convex region is defined as an AABB (-0.5,-0.5,-0.5) to (0.5, 0.5, 0.5).

Member Function Documentation

void lexis::render::ClipPlanes::clear ( )

Clears all planes, results in isEmpty() == true.

bool lexis::render::ClipPlanes::isEmpty ( ) const
Returns
true if there are no clipping planes.
bool lexis::render::ClipPlanes::isOutside ( const vmml::AABBf &  box) const
Returns
true if the box is outside the clip planes, aka shall be clipped.
void lexis::render::ClipPlanes::reset ( )

Reset to planes setup by constructor.


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