Doxygen Source Code Documentation

Main Page Alphabetical List Data Structures File List Data Fields Globals Search

SUMA_SurfaceViewer Struct Reference

#include <SUMA_define.h>


Data Fields
int	N_DO
int *	RegisteredDO
SUMA_Boolean	Record
SUMA_Boolean	ShowLeft
SUMA_Boolean	ShowRight
SUMA_COLORLIST_STRUCT *	ColList
int	N_ColList
SUMA_STANDARD_VIEWS	StdView
SUMA_GEOMVIEW_STRUCT *	GVS
int	N_GVS
short	verbose
SUMA_X *	X
int	ortho
float	Aspect
int	WindWidth
int	WindHeight
float	ZoomCompensate
float *	FOV
float	ArrowRotationAngle
SUMA_Boolean	BF_Cull
SUMA_RENDER_MODES	PolyMode
float	Back_Modfact
GLfloat	light0_position [4]
GLfloat	light1_position [4]
GLfloat	clear_color [4]
SUMA_Boolean	Open
int	ShowEyeAxis
int	ShowMeshAxis
int	ShowWorldAxis
SUMA_Axis *	WorldAxis
int	ShowCrossHair
SUMA_Boolean	ShowForeground
SUMA_Boolean	ShowBackground
SUMA_Boolean	UsePatchDims
int	Focus_SO_ID
int	Focus_DO_ID
GLdouble	Pick0 [3]
GLdouble	Pick1 [3]
GLdouble	Pcenter_close [3]
GLdouble	Pcenter_far [3]
GLdouble	Plist_close [3]
SUMA_CrossHair *	Ch
SUMA_Axis *	WAx
SUMA_ViewState *	VSv
int	N_VSv
char *	State
int	iState
int	LastNonMapStateID
SUMA_Boolean	isShaded
SUMA_Boolean	LinkAfniCrossHair
SUMA_Boolean	ResetGLStateVariables
SUMA_Boolean	NewGeom
DList *	BS
char *	CurGroupName
int	iCurGroup
SUMA_REDISPLAY_CAUSE	rdc

Detailed Description

structure defining the state of a viewer window

Definition at line 1330 of file SUMA_define.h.

Field Documentation

float SUMA_SurfaceViewer::ArrowRotationAngle

Angle to rotate surface by when arrows are used. Units are in radians

Definition at line 1355 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_input(), and SUMA_SurfaceViewer_StructInfo().

float SUMA_SurfaceViewer::Aspect

Aspect ratio of the viewer

Definition at line 1350 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_LoadVisualState(), SUMA_resize(), SUMA_SaveVisualState(), and SUMA_SurfaceViewer_StructInfo().

float SUMA_SurfaceViewer::Back_Modfact

Factor to apply when modulating foreground color with background intensity background does not modulate foreground, Color = Fore * avg_Bright * AttenFactor; (w/ 0 <= avg_Bright <=1) a good setting is such that SUMA_BACKGROUND_ATTENUATION_FACTOR * SUMA_DIM_AFNI_COLOR_FACTOR = 1 Watch for saturation effects!

Definition at line 1364 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_input(), SUMA_LoadVisualState(), SUMA_Overlays_2_GLCOLAR4(), SUMA_SaveVisualState(), SUMA_SurfaceViewer_StructInfo(), and SUMA_SwitchState().

SUMA_Boolean SUMA_SurfaceViewer::BF_Cull

flag for backface culling

Definition at line 1357 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_context_Init(), SUMA_input(), SUMA_LoadVisualState(), and SUMA_SaveVisualState().

DList* SUMA_SurfaceViewer::BS

The new version of BrushStroke, in doubly linked list form

Definition at line 1412 of file SUMA_define.h.

Referenced by SUMA_AddToBrushStroke(), SUMA_Alloc_SurfaceViewer_Struct(), SUMA_BrushStrokeToNodeStroke(), SUMA_ClearBrushStroke(), SUMA_CreateBrushStroke(), SUMA_DrawBrushStroke(), SUMA_Free_SurfaceViewer_Struct(), SUMA_input(), SUMA_LinkTailNodeToNodeStroke(), SUMA_NodeStrokeToConnectedNodes(), SUMA_ProcessBrushStroke(), and SUMA_ShowBrushStroke().

SUMA_CrossHair* SUMA_SurfaceViewer::Ch

Pointer to Cross Hair structure

Definition at line 1397 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_display(), SUMA_Engine(), SUMA_Free_SurfaceViewer_Struct(), SUMA_input(), SUMA_makeNI_CrossHair(), SUMA_SwitchState(), SUMA_UpdateXhairField(), and SUMA_XhairInput().

GLfloat SUMA_SurfaceViewer::clear_color[4]

viewer background color

Definition at line 1373 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_context_Init(), SUMA_display(), SUMA_input(), SUMA_LoadVisualState(), and SUMA_SaveVisualState().

SUMA_COLORLIST_STRUCT* SUMA_SurfaceViewer::ColList

pointer to structures containing NodeColorLists for surfaces listed in RegisteredDO

Definition at line 1338 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_EmptyColorList(), SUMA_FillColorList(), SUMA_Free_SurfaceViewer_Struct(), SUMA_GetColorList(), SUMA_MixColors(), SUMA_RegisterDO(), SUMA_SetAllRemixFlag(), SUMA_SetLocalRemixFlag(), SUMA_SetRemixFlag(), and SUMA_SetShownLocalRemixFlag().

char* SUMA_SurfaceViewer::CurGroupName

current name of group

Definition at line 1414 of file SUMA_define.h.

Referenced by SUMA_AdoptGroup(), SUMA_AdoptSurfGroup(), SUMA_Alloc_SurfaceViewer_Struct(), SUMA_cb_createViewerCont(), SUMA_Free_SurfaceViewer_Struct(), SUMA_input(), SUMA_isVisibleSO(), SUMA_NextState(), SUMA_PrevState(), SUMA_process_NIML_data(), SUMA_RegisteredSOs(), SUMA_SetupSVforDOs(), SUMA_SurfaceViewer_StructInfo(), SUMA_SwitchGroups(), SUMA_SwitchState(), SUMA_UpdateViewerTitle(), SUMA_VisibleSOs(), and SUMA_WhichState().

int SUMA_SurfaceViewer::Focus_DO_ID

index into SUMAg_DOv of the Displayabl Object currently in focus -1 for nothing

Definition at line 1386 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), and SUMA_SurfaceViewer_StructInfo().

int SUMA_SurfaceViewer::Focus_SO_ID

index into SUMAg_DOv of the surface currently in focus, -1 for nothing

Definition at line 1385 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_BrushStrokeToNodeStroke(), SUMA_cb_viewSurfaceCont(), SUMA_Engine(), SUMA_input(), SUMA_JumpIndex(), SUMA_LinkTailNodeToNodeStroke(), SUMA_LinkThisNodeToNodeInStroke(), SUMA_makeNI_CrossHair(), SUMA_MarkLineSurfaceIntersect(), SUMA_NodeStrokeToConnectedNodes(), SUMA_OpenDrawnROI(), SUMA_process_NIML_data(), SUMA_ProcessBrushStroke(), SUMA_RenderToPixMap(), SUMA_SetupSVforDOs(), SUMA_SurfaceViewer_StructInfo(), SUMA_SwitchSO(), SUMA_SwitchState(), SUMA_UpdateViewerTitle(), and SUMA_UpdateViewerTitle_old().

float* SUMA_SurfaceViewer::FOV

Field of View (affects zoom level, there is a separate FOV for each ViewState)

Definition at line 1354 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_Engine(), SUMA_input(), SUMA_LoadVisualState(), SUMA_RegisterSpecSO(), SUMA_SaveVisualState(), and SUMA_SurfaceViewer_StructInfo().

SUMA_GEOMVIEW_STRUCT* SUMA_SurfaceViewer::GVS

Definition at line 1342 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_ButtClose_pushed(), SUMA_context_Init(), SUMA_display(), SUMA_Engine(), SUMA_EyeAxisStandard(), SUMA_Free_SurfaceViewer_Struct(), SUMA_GetSelectionLine(), SUMA_input(), SUMA_LoadVisualState(), SUMA_mapStateChanged(), SUMA_momentum(), SUMA_NewGeometryInViewer(), SUMA_resize(), SUMA_SaveVisualState(), SUMA_SurfaceViewer_StructInfo(), SUMA_UpdateRotaCenter(), SUMA_UpdateViewerTitle(), SUMA_UpdateViewerTitle_old(), SUMA_UpdateViewPoint(), SUMA_WhichViewerInMomentum(), SUMA_World2ScreenCoords(), and SUMA_WorldAxisStandard().

int SUMA_SurfaceViewer::iCurGroup

index into GroupList (stored in SUMAg_CF) of current group of Surface Viewer

Definition at line 1415 of file SUMA_define.h.

Referenced by SUMA_AdoptGroup(), SUMA_AdoptSurfGroup(), SUMA_Alloc_SurfaceViewer_Struct(), SUMA_SetupSVforDOs(), and SUMA_SurfaceViewer_StructInfo().

SUMA_Boolean SUMA_SurfaceViewer::isShaded

YUP if the window is minimized or shaded, NOPE if you can see its contents

Definition at line 1406 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_cb_helpIO_notify(), SUMA_cb_helpMemTrace(), SUMA_Engine(), SUMA_mapStateChanged(), SUMA_NewSurfaceGeometry(), SUMA_PopUpMessage(), and SUMA_SwitchGroups().

int SUMA_SurfaceViewer::iState

index into VSv corresponding to State

Definition at line 1403 of file SUMA_define.h.

Referenced by SUMA_BestStandardView(), SUMA_Engine(), SUMA_input(), SUMA_LoadVisualState(), SUMA_SaveVisualState(), SUMA_SetupSVforDOs(), SUMA_SurfaceViewer_StructInfo(), and SUMA_SwitchState().

int SUMA_SurfaceViewer::LastNonMapStateID

Index into the state in VSv from which a toggle to the mappable state was initiated

Definition at line 1404 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_input(), and SUMA_SurfaceViewer_StructInfo().

GLfloat SUMA_SurfaceViewer::light0_position[4]

Light 0 position: 1st 3 vals --> direction of light . Last value is 0 --> directional light

Definition at line 1370 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_context_Init(), SUMA_Engine(), SUMA_input(), SUMA_SetupSVforDOs(), and SUMA_SurfaceViewer_StructInfo().

GLfloat SUMA_SurfaceViewer::light1_position[4]

Light 1 position: 1st 3 vals --> direction of light. Last value is 0 --> directional light

Definition at line 1371 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), and SUMA_SurfaceViewer_StructInfo().

SUMA_Boolean SUMA_SurfaceViewer::LinkAfniCrossHair

YUP if the cross hair location is to be sent (and accepted from AFNI, when the stream is open)

Definition at line 1408 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_JumpIndex(), SUMA_JumpXYZ(), SUMA_MarkLineSurfaceIntersect(), and SUMA_process_NIML_data().

int SUMA_SurfaceViewer::N_ColList

Number of structures in ColList

Definition at line 1339 of file SUMA_define.h.

int SUMA_SurfaceViewer::N_DO

Total number of surface objects registered with the viewer

Definition at line 1331 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_display(), SUMA_Engine(), SUMA_GetEyeAxis(), SUMA_input(), SUMA_isVisibleSO(), SUMA_NewSurfaceGeometry(), SUMA_RedisplayAllShowing(), SUMA_RegisterDO(), SUMA_RegisteredSOs(), SUMA_SetLocalRemixFlag(), SUMA_SetRemixFlag(), SUMA_SurfaceViewer_StructInfo(), SUMA_UnRegisterDO(), SUMA_UpdateRotaCenter(), SUMA_UpdateViewPoint(), and SUMA_VisibleSOs().

int SUMA_SurfaceViewer::N_GVS

Number of different geometric viewing structures

Definition at line 1343 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct().

int SUMA_SurfaceViewer::N_VSv

Number of Viewing State structures

Definition at line 1401 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_Free_SurfaceViewer_Struct(), SUMA_input(), SUMA_New_ViewState(), SUMA_NextState(), SUMA_PrevState(), SUMA_RegisterSpecSO(), SUMA_SurfaceViewer_StructInfo(), and SUMA_WhichState().

SUMA_Boolean SUMA_SurfaceViewer::NewGeom

YUP if viewer has new geometry in it and needs to have its default viewing settings updated

Definition at line 1411 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_display(), and SUMA_NewSurfaceGeometry().

SUMA_Boolean SUMA_SurfaceViewer::Open

Definition at line 1375 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_ButtClose_pushed(), SUMA_handleRedisplay(), and SUMA_X_SurfaceViewer_Create().

int SUMA_SurfaceViewer::ortho

Orthographic (1) or perspective (0, default) projection

Definition at line 1349 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_input(), and SUMA_SurfaceViewer_StructInfo().

GLdouble SUMA_SurfaceViewer::Pcenter_close[3]

Center of screen in World coordinates , at z = 0 (near clip plane)

Definition at line 1390 of file SUMA_define.h.

Referenced by SUMA_display(), and SUMA_SortedAxisSegmentList().

GLdouble SUMA_SurfaceViewer::Pcenter_far[3]

Center of screen in World coordinates , at z = 1 (near far plane)

Definition at line 1391 of file SUMA_define.h.

Referenced by SUMA_display().

GLdouble SUMA_SurfaceViewer::Pick0[3]

Click location in World coordinates, at z = 0 (near clip plane)

Definition at line 1388 of file SUMA_define.h.

Referenced by SUMA_display(), SUMA_input(), and SUMA_MarkLineSurfaceIntersect().

GLdouble SUMA_SurfaceViewer::Pick1[3]

Click location in World coordinates, at z = 1.0 (far clip plane)

Definition at line 1389 of file SUMA_define.h.

Referenced by SUMA_display(), SUMA_input(), and SUMA_MarkLineSurfaceIntersect().

GLdouble SUMA_SurfaceViewer::Plist_close[3]

lists of points on screen in world coordinates at z = 0 it holds N/3 points where N is the array length At the moment, all I need is one point, the lower left Should more be needed, I will add them to the list and document them here.

Definition at line 1392 of file SUMA_define.h.

Referenced by SUMA_display().

SUMA_RENDER_MODES SUMA_SurfaceViewer::PolyMode

polygon viewing mode, SRM_Fill, SRM_Line, SRM_Points There is a similar field for each surface object to allow independent control for each surface. If the rendering mode is specified for a certain surface, it takes precedence over the one specified here

Definition at line 1358 of file SUMA_define.h.

Referenced by SUMA_Alloc_SurfaceViewer_Struct(), SUMA_context_Init(), SUMA_DrawMesh(), SUMA_input(), SUMA_LoadVisualState(), SUMA_SaveVisualState(), and SUMA_SurfaceViewer_StructInfo().