mve::Scene Class Reference

Scene representation for the MVE. More...

#include <scene.h>

Public Types
typedef std::shared_ptr< Scene >	Ptr
typedef std::vector< View::Ptr >	ViewList

Public Member Functions
	Scene (const Scene &)=delete
void	cache_cleanup (void)
	Forces cleanup of unused embeddings.
Bundle::ConstPtr	get_bundle (void)
	Returns the bundle structure.
std::size_t	get_bundle_mem_usage (void)
	Returns key point memory usage.
std::string const &	get_path (void) const
	Returns the base path of the scene.
std::size_t	get_total_mem_usage (void)
	Returns total scene memory usage.
View::Ptr	get_view_by_id (std::size_t id)
	Returns a view by ID or 0 on failure.
std::size_t	get_view_mem_usage (void)
	Returns view memory usage.
ViewList &	get_views (void)
	Returns the list of views.
ViewList const &	get_views (void) const
	Returns the list of views.
bool	is_dirty (void) const
	Returns true if one of the views or the bundle file is dirty.
void	load_scene (std::string const &base_path)
	Loads the scene from the given directory.
Scene &	operator= (const Scene &)=delete
void	reset_bundle (void)
	Resets the bundle file such that it is re-read on get_bundle.
void	rewrite_all_views (void)
	Forces rewriting of all views.
void	save_bundle (void)
	Saves the bundle file if dirty.
void	save_scene (void)
	Saves bundle file if dirty as well as dirty embeddings.
void	save_views (void)
	Saves dirty embeddings only.
void	set_bundle (Bundle::Ptr bundle)
	Sets a new bundle structure.

Static Public Member Functions
static Scene::Ptr	create (std::string const &path)
	Constructs and loads a scene from the given directory.

Protected Member Functions
	Scene (void)

Detailed Description

Scene representation for the MVE.

A scene is loaded by specifying the scene root directory. The following files and directories are recognized within the scene root:

• directory "views": contains the views in the scene.
• file "synth_0.out": bundle file that contains key points.

Definition at line 34 of file scene.h.

Member Typedef Documentation

Ptr

typedef std::shared_ptr<Scene> mve::Scene::Ptr

Definition at line 37 of file scene.h.

ViewList

typedef std::vector<View::Ptr> mve::Scene::ViewList

Definition at line 38 of file scene.h.

Constructor & Destructor Documentation

Scene() [1/2]

mve::Scene::Scene ( const Scene &  )

delete

Scene() [2/2]

mve::Scene::Scene ( void  )

inlineprotected

Definition at line 105 of file scene.h.

Member Function Documentation

cache_cleanup()

void mve::Scene::cache_cleanup

(

void

)

Forces cleanup of unused embeddings.

Definition at line 81 of file scene.cc.

create()

Scene::Ptr mve::Scene::create ( std::string const &  path )

inlinestatic

Constructs and loads a scene from the given directory.

Definition at line 111 of file scene.h.

get_bundle()

Bundle::ConstPtr mve::Scene::get_bundle

(

void

)

Returns the bundle structure.

Definition at line 210 of file scene.cc.

get_bundle_mem_usage()

std::size_t mve::Scene::get_bundle_mem_usage

(

void

)

Returns key point memory usage.

Definition at line 133 of file scene.cc.

get_path()

std::string const & mve::Scene::get_path ( void  ) const

inline

Returns the base path of the scene.

Definition at line 137 of file scene.h.

get_total_mem_usage()

std::size_t mve::Scene::get_total_mem_usage

(

void

)

Returns total scene memory usage.

Definition at line 110 of file scene.cc.

get_view_by_id()

View::Ptr mve::Scene::get_view_by_id ( std::size_t  id )

inline

Returns a view by ID or 0 on failure.

Definition at line 131 of file scene.h.

get_view_mem_usage()

std::size_t mve::Scene::get_view_mem_usage

(

void

)

Returns view memory usage.

Definition at line 121 of file scene.cc.

get_views() [1/2]

Scene::ViewList & mve::Scene::get_views ( void  )

inline

Returns the list of views.

Definition at line 125 of file scene.h.

get_views() [2/2]

Scene::ViewList const & mve::Scene::get_views ( void  ) const

inline

Returns the list of views.

Definition at line 119 of file scene.h.

is_dirty()

bool mve::Scene::is_dirty

(

void

)

const

Returns true if one of the views or the bundle file is dirty.

Definition at line 66 of file scene.cc.

load_scene()

void mve::Scene::load_scene

(

std::string const &

base_path

)

Loads the scene from the given directory.

Definition at line 22 of file scene.cc.

operator=()

Scene & mve::Scene::operator= ( const Scene &  )

delete

reset_bundle()

void mve::Scene::reset_bundle ( void  )

inline

Resets the bundle file such that it is re-read on get_bundle.

Definition at line 150 of file scene.h.

rewrite_all_views()

void mve::Scene::rewrite_all_views

(

void

)

Forces rewriting of all views.

Can take a long time.

save_bundle()

void mve::Scene::save_bundle

(

void

)

Saves the bundle file if dirty.

Definition at line 42 of file scene.cc.

save_scene()

void mve::Scene::save_scene

(

void

)

Saves bundle file if dirty as well as dirty embeddings.

Definition at line 33 of file scene.cc.

save_views()

void mve::Scene::save_views

(

void

)

Saves dirty embeddings only.

Definition at line 54 of file scene.cc.

set_bundle()

void mve::Scene::set_bundle ( Bundle::Ptr  bundle )

inline

Sets a new bundle structure.

Definition at line 143 of file scene.h.

---

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

• /builddir/build/BUILD/mve-354a652461377939ca136f451ba3271a1c52ee65/libs/mve/scene.h
• /builddir/build/BUILD/mve-354a652461377939ca136f451ba3271a1c52ee65/libs/mve/scene.cc