The MNE Msh Display Surface Set class holds information about a set of surfaces to be rendered. More...

#include <mne_msh_display_surface_set.h>

Public Types
typedef QSharedPointer< MNEMshDisplaySurfaceSet >	SPtr
typedef QSharedPointer< const MNEMshDisplaySurfaceSet >	ConstSPtr

Public Member Functions
	MNEMshDisplaySurfaceSet (int nsurf=0)
	~MNEMshDisplaySurfaceSet ()
int	add_bem_surface (const QString &filepath, int kind, const QString &bemname, int full_geom, int check)
void	add_replace_surface (std::unique_ptr< MNEMshDisplaySurface > newSurf, bool replace, bool drawable)
void	apply_left_right_eyes ()
void	apply_left_eyes ()
void	setup_current_lights ()
void	setup_lights (const MNEMshLightSet &set)

Static Public Member Functions
static std::unique_ptr< MNEMshDisplaySurfaceSet >	load (const QString &subject_id, const QString &surf, const QString &subjects_dir)
static void	initialize_custom_lights ()
static std::unique_ptr< MNEMshLightSet >	dup_light_set (const MNEMshLightSet &s)

Public Attributes
QString	subj
QString	morph_subj
std::vector< std::unique_ptr< MNEMshDisplaySurface > >	surfs
std::vector< std::unique_ptr< MNESurfacePatch > >	patches
std::vector< float >	patch_rot
int	nsurf
int	use_patches
Eigen::VectorXi	active
Eigen::VectorXi	drawable
std::unique_ptr< MNEMshLightSet >	lights
float	rot [3]
float	move [3]
float	fov
float	fov_scale
float	eye [3]
float	up [3]
float	bg_color [3]
float	text_color [3]

Detailed Description

The MNE Msh Display Surface Set class holds information about a set of surfaces to be rendered.

Replaces *mshDisplaySurfaceSet, mshDisplaySurfaceSetRec struct (analyze_types.c). Note that another implementation can be found in movie_types.h

Definition at line 88 of file mne_msh_display_surface_set.h.

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const MNEMshDisplaySurfaceSet> MNELIB::MNEMshDisplaySurfaceSet::ConstSPtr

Const shared pointer type for MNEMshDisplaySurfaceSet.

Definition at line 92 of file mne_msh_display_surface_set.h.

◆ SPtr

typedef QSharedPointer<MNEMshDisplaySurfaceSet> MNELIB::MNEMshDisplaySurfaceSet::SPtr

Shared pointer type for MNEMshDisplaySurfaceSet.

Definition at line 91 of file mne_msh_display_surface_set.h.

Constructor & Destructor Documentation

◆ MNEMshDisplaySurfaceSet()

MNEMshDisplaySurfaceSet::MNEMshDisplaySurfaceSet ( int nsurf = 0 )

Constructs the MNEMshDisplaySurfaceSet.

Definition at line 104 of file mne_msh_display_surface_set.cpp.

◆ ~MNEMshDisplaySurfaceSet()

MNEMshDisplaySurfaceSet::~MNEMshDisplaySurfaceSet ( )

default

Destroys the MNEMshDisplaySurfaceSet.

Member Function Documentation

◆ add_bem_surface()

int MNEMshDisplaySurfaceSet::add_bem_surface	(	const QString &	filepath,
		int	kind,
		const QString &	bemname,
		int	full_geom,
		int	check )

Read a BEM surface from a FIFF file, optionally validate that it is topologically closed (via solid-angle check), and add it to this set.

Parameters

[in]	filepath	Path to the BEM FIFF file.
[in]	kind	BEM surface kind constant.
[in]	bemname	Display name for the surface.
[in]	full_geom	If non-zero, compute full geometry information.
[in]	check	If non-zero, verify the surface is closed.

Returns: OK on success, FAIL on error.

Definition at line 205 of file mne_msh_display_surface_set.cpp.

◆ add_replace_surface()

void MNEMshDisplaySurfaceSet::add_replace_surface	(	std::unique_ptr< MNEMshDisplaySurface >	newSurf,
		bool	replace,
		bool	drawable )

Add a new surface to the set, or replace an existing surface with the same ID if replace is true.

Parameters

[in]	newSurf	The surface to add or use as replacement.
[in]	replace	If true, replace an existing surface with matching ID.
[in]	drawable	Whether the surface should be marked as drawable.

Definition at line 249 of file mne_msh_display_surface_set.cpp.

◆ apply_left_eyes()

void MNEMshDisplaySurfaceSet::apply_left_eyes ( )

Apply the left-eye position and up-vector uniformly to all surfaces regardless of hemisphere.

Definition at line 315 of file mne_msh_display_surface_set.cpp.

◆ apply_left_right_eyes()

void MNEMshDisplaySurfaceSet::apply_left_right_eyes ( )

Assign hemisphere-appropriate eye positions and up-vectors to each surface (left eye for left hemisphere, right eye for right).

Definition at line 282 of file mne_msh_display_surface_set.cpp.

◆ dup_light_set()

std::unique_ptr< MNEMshLightSet > MNEMshDisplaySurfaceSet::dup_light_set ( const MNEMshLightSet & s )

static

Deep-copy a light set including all individual light entries.

Parameters

[in] s The light set to duplicate.

Returns: A new deep copy. Caller takes ownership.

Definition at line 357 of file mne_msh_display_surface_set.cpp.

◆ initialize_custom_lights()

void MNEMshDisplaySurfaceSet::initialize_custom_lights ( )

static

Create a default set of 8 directional lights if custom lights have not been initialized yet.

Definition at line 339 of file mne_msh_display_surface_set.cpp.

◆ load()

std::unique_ptr< MNEMshDisplaySurfaceSet > MNEMshDisplaySurfaceSet::load	(	const QString &	subject_id,
		const QString &	surf,
		const QString &	subjects_dir )