iridescence
Loading...
Searching...
No Matches
guik Namespace Reference

Classes

class  ArcBallCameraControl
class  BasicProjectionControl
class  CameraControl
 Base class for camera control. This class defines the interface for controlling the camera in the viewer. It provides virtual methods for handling mouse input, updating the camera state, and getting the view matrix. Derived classes can implement specific camera control schemes (e.g., orbit, FPV) by overriding these methods. More...
class  FPSCameraControl
class  OrbitCameraControlXY
 Orbit camera control (Up vector is locked to Z axis) Left button: rotate (pan/tilt) Middle or Right button: XY translate Middle & Right button: Z translate Scroll wheel: zoom in/out. More...
class  OrbitCameraControlXZ
class  ProjectionControl
class  SensorViewCameraControl
 Camera control that orbits around a tracked sensor pose. The camera always looks at the sensor position, with user-controlled azimuth/elevation and distance scaling. More...
class  StaticCameraControl
class  StaticProjectionControl
class  TopDownCameraControl
class  ConcurrentQueue
class  StdConcurrentQueue
class  GLCanvas
class  HoveredDrawing
class  HoveredDrawings
class  HoveredText
class  HoveredCross
class  HoveredCircle
class  HoveredTriangle
class  HoveredFilledTriangle
class  HoveredRect
class  HoveredFilledRect
class  HoveredImage
class  Application
class  ModelControl
struct  ProgressInterface
class  ProgressModal
class  RecentFiles
class  ScreenCapture
 Screen capture utility to asynchronously fetch rendering results and save them as images. More...
class  TbbConcurrentQueue
class  AsyncLightViewer
class  AsyncLightViewerContext
 Async interface to manipulate LightViewerContext. All OpenGL operations will be called in the viewer thread through invoke method. Note that async operations come at a cost of data copy. More...
class  LightViewer
 Light viewer. The main visualization class in Iridescence. More...
class  LightViewerContext
 Viewer context. More...
struct  PlotData
struct  LinePlotData
struct  ScatterPlotData
struct  StairsPlotData
struct  HistogramPlotData
struct  PlotStyle
struct  LinePlotStyle
struct  ScatterPlotStyle
struct  PlotSetting
struct  ColorMode
 Fragment color mode. RAINBOW : Color mapped by 3D coordinates of pixels (by default, Z-axis is used for color mapping) FLAT_COLOR : Single flat color VERTEX_COLOR : Color from vertex color attribute TEXTURE_COLOR : Color from texture map VERTEX_COLORMAP : Color from vertex colormap attribute. More...
struct  PointScaleMode
 Point size scale mode. SCREENSPACE : Screen space size METRIC : Metric size (in meters). More...
struct  PointShapeMode
 Point shape mode. RECTANGLE : Square/rectangle shape CIRCLE : Circle shape. More...
struct  ShaderParameter
 Shader parameter class that holds a single parameter for shader setting. More...
struct  ShaderSetting
 Shader setting class that holds rendering settings. More...
struct  Rainbow
 Rainbow coloring scheme that assigns colors to the height (z-value) of pixels of the object. The coloring band can be changed by setting z_range param. The direction for the color mapping can be changed by setting colormap_axis param. More...
struct  FlatColor
 Flat coloring scheme that assigns a single color to the object. If the alpha value is less than 0.999f, the object is rendered as transparent. More...
struct  FlatRed
 Flat red color. More...
struct  FlatGreen
 Flat green color. More...
struct  FlatBlue
 Flat blue color. More...
struct  FlatOrange
 Flat orange color. More...
struct  FlatWhite
 Flat white color. More...
struct  FlatGray
 Flat light gray color. More...
struct  FlatDarkGray
 Flat dark gray color. More...
struct  FlatBlack
 Flat black color. More...
struct  VertexColor
 Vertex color scheme that assigns colors based on vertex color attributes. More...
struct  TextureColor
 Texture color scheme that assigns colors based on the binded texture. More...
struct  VertexColorMap
 Vertex colormap scheme that assigns colors based on vertex colormap attributes. More...

Typedefs

using PlotDataConstPtr = std::shared_ptr<const PlotData>
using PlotStyleConstPtr = std::shared_ptr<const PlotStyle>

Enumerations

enum class  ShaderDataType {
  INT = 0 , INT2 , INT3 , INT4 ,
  FLOAT , FLOAT2 , FLOAT3 , FLOAT4 ,
  MATRIX4 , INT_ARRAY , FLOAT_ARRAY , INVALID
}
 Data type of shader parameter. More...

Functions

std::istream & operator>> (std::istream &ist, CameraControl &cam)
std::ostream & operator<< (std::ostream &ost, const CameraControl &cam)
std::istream & operator>> (std::istream &ist, ProjectionControl &cam)
std::ostream & operator<< (std::ostream &ost, const ProjectionControl &cam)
template<typename RingBufferSink>
std::function< void()> create_logger_ui (const std::shared_ptr< RingBufferSink > &sink, double bg_alpha=1.0)
std::string anon ()
 Generate a unique name.
AsyncLightViewer * async_viewer (const Eigen::Vector2i &size=Eigen::Vector2i(-1, -1), bool background=false, const std::string &title="screen")
void async_destroy ()
void async_wait ()
void async_wait_until_click ()
void async_toggle_wait ()
bool async_running ()
LightViewer * viewer (const Eigen::Vector2i &size=Eigen::Vector2i(-1, -1), bool background=false, const std::string &title="screen")
 Create or get the singleton LightViewer instance.
LightViewer * viewer (const std::string &title, const Eigen::Vector2i &size=Eigen::Vector2i(-1, -1), bool background=false)
 Create or get the singleton LightViewer instance.
void destroy ()
 Destroy the singleton LightViewer instance.
bool running ()
 Check if the LightViewer instance is running.
template<typename T>
ShaderDataType deduce_data_type ()
 Deduce shader data type from C++ type.

Typedef Documentation

◆ PlotDataConstPtr

using guik::PlotDataConstPtr = std::shared_ptr<const PlotData>

◆ PlotStyleConstPtr

using guik::PlotStyleConstPtr = std::shared_ptr<const PlotStyle>

Enumeration Type Documentation

◆ ShaderDataType

enum class guik::ShaderDataType
strong

Data type of shader parameter.

Enumerator
INT 
INT2 
INT3 
INT4 
FLOAT 
FLOAT2 
FLOAT3 
FLOAT4 
MATRIX4 
INT_ARRAY 
FLOAT_ARRAY 
INVALID 

Function Documentation

◆ anon()

std::string guik::anon ( )

Generate a unique name.

◆ async_destroy()

void guik::async_destroy ( )
inline

◆ async_running()

bool guik::async_running ( )
inline

◆ async_toggle_wait()

void guik::async_toggle_wait ( )
inline

◆ async_viewer()

AsyncLightViewer * guik::async_viewer ( const Eigen::Vector2i & size = Eigen::Vector2i(-1, -1),
bool background = false,
const std::string & title = "screen" )
inline

◆ async_wait()

void guik::async_wait ( )
inline

◆ async_wait_until_click()

void guik::async_wait_until_click ( )
inline

◆ create_logger_ui()

template<typename RingBufferSink>
std::function< void()> guik::create_logger_ui ( const std::shared_ptr< RingBufferSink > & sink,
double bg_alpha = 1.0 )

usage:

auto ringbuffer_sink = std::make_shared<spdlog::sinks::ringbuffer_sink_mt>(128); spdlog::default_logger()->sinks().emplace_back(ringbuffer_sink); viewer->register_ui_callback("logging", guik::create_logger_ui(ringbuffer_sink));

◆ deduce_data_type()

template<typename T>
ShaderDataType guik::deduce_data_type ( )

Deduce shader data type from C++ type.

◆ destroy()

void guik::destroy ( )
inline

Destroy the singleton LightViewer instance.

◆ operator<<() [1/2]

std::ostream & guik::operator<< ( std::ostream & ost,
const CameraControl & cam )

◆ operator<<() [2/2]

std::ostream & guik::operator<< ( std::ostream & ost,
const ProjectionControl & cam )

◆ operator>>() [1/2]

std::istream & guik::operator>> ( std::istream & ist,
CameraControl & cam )

◆ operator>>() [2/2]

std::istream & guik::operator>> ( std::istream & ist,
ProjectionControl & cam )

◆ running()

bool guik::running ( )
inline

Check if the LightViewer instance is running.

◆ viewer() [1/2]

LightViewer * guik::viewer ( const Eigen::Vector2i & size = Eigen::Vector2i(-1, -1),
bool background = false,
const std::string & title = "screen" )
inline

Create or get the singleton LightViewer instance.

Parameters
sizeInitial canvas size. If (-1, -1), use default size.
backgroundIf true, the viewer window is created in the background (invisible).
titleWindow title.
Returns
Pointer to the LightViewer instance.

◆ viewer() [2/2]

LightViewer * guik::viewer ( const std::string & title,
const Eigen::Vector2i & size = Eigen::Vector2i(-1, -1),
bool background = false )
inline

Create or get the singleton LightViewer instance.

Parameters
titleWindow title.
sizeInitial canvas size. If (-1, -1), use default size.
backgroundIf true, the viewer window is created in the background (invisible).
Returns
Pointer to the LightViewer instance.