The ClipSubRegion class is used to define a ClipRegionKey. More...

#include <sc_store.h>

Public Types

enum  Operation : uint32_t { Keep, Remove }
 
enum  Space : uint32_t { World, Window }
 

Public Member Functions

 ClipSubRegion ()
 
 ClipSubRegion (MatrixKey matrix, Operation operation, Space space)
 
bool operator!= (ClipSubRegion const &that) const
 
bool operator== (ClipSubRegion const &that) const
 

Public Attributes

MatrixKey matrix
 
Operation operation
 
PolyPolygonKeys polypolygons
 
Space space
 

Detailed Description

The ClipSubRegion class is used to define a ClipRegionKey.

Member Enumeration Documentation

◆ Operation

Enumerator
Keep 

The geometry inside the clip region is drawn. Everything outside of it is clipped.

Remove 

The geometry outside the clip region is drawn. Everything inside of it is clipped.

◆ Space

Enumerator
World 

The clip region is specified in world coordinates.

Window 

The clip region is specified in window coordinates. -1 to 1.

Constructor & Destructor Documentation

◆ ClipSubRegion() [1/2]

SC::Store::ClipSubRegion::ClipSubRegion ( )

◆ ClipSubRegion() [2/2]

SC::Store::ClipSubRegion::ClipSubRegion ( MatrixKey  matrix,
Operation  operation,
Space  space 
)

Member Function Documentation

◆ operator!=()

bool SC::Store::ClipSubRegion::operator!= ( ClipSubRegion const &  that) const

◆ operator==()

bool SC::Store::ClipSubRegion::operator== ( ClipSubRegion const &  that) const

Member Data Documentation

◆ matrix

MatrixKey SC::Store::ClipSubRegion::matrix

The transformation matrix for this ClipSubRegion (optional).

◆ operation

Operation SC::Store::ClipSubRegion::operation

The ClipSubRegion::Operation to use; defaults to Keep.

◆ polypolygons

PolyPolygonKeys SC::Store::ClipSubRegion::polypolygons

The polypolygons that define this ClipSubRegion.

◆ space

Space SC::Store::ClipSubRegion::space

The ClipSubRegion::Space coordinate type to use for defining this ClipSubRegion; defaults to World space.