occtl::viz::Presentable Class Reference

RAII wrapper for a display object bound to a graph root. More...

#include <viz.hpp>

Public Member Functions
	Presentable (Viewer &theViewer, Graph &theGraph, const NodeId theRoot)
	Creates a display object for a graph root.
	Presentable (const Presentable &)=delete
Presentable &	operator= (const Presentable &)=delete
	Presentable (Presentable &&theOther) noexcept
Presentable &	operator= (Presentable &&theOther) noexcept
void	set_display_mode (const DisplayMode theMode)
	Sets the display mode.
bool	synchronize ()
	Synchronizes presentation after graph or metadata changes.
void	invalidate ()
	Invalidates cached presentation state.
void	set_visible_nodes (const std::vector< NodeId > &theNodes)
	Restricts display to a visible node mask.
void	clear_visible_nodes ()
	Clears a visible node mask (display everything).
::occtl_viz_presentable_t *	get () const noexcept

Detailed Description

RAII wrapper for a display object bound to a graph root.

A Presentable borrows its source Graph and must not outlive it.

Member Function Documentation

synchronize()

bool occtl::viz::Presentable::synchronize ( )

inline

Synchronizes presentation after graph or metadata changes.

Returns

true when the synchronized state differs from the cached state.

---

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

• include/occtl-hpp/viz.hpp