gui_modules.wxnviz.Nviz Class Reference

Public Member Functions
def	__init__
	Initialize Nviz class instance.
def	__del__
	Destroy Nviz class instance.
def	ResizeWindow
	GL canvas resized.
def	SetViewDefault
	Set default view (based on loaded data)
def	SetView
	Change view settings.
def	SetZExag
	Set z-exag value.
def	Draw
	Draw canvas.
def	EraseMap
	Erase map display (with background color)
def	InitView
	Initialize view.
def	SetBgColor
	Set background color.
def	SetLight
	Change lighting settings.
def	LoadSurface
	Load raster map (surface)
def	UnloadSurface
	Unload surface.
def	LoadVector
	Load vector map overlay.
def	UnloadVector
	Unload vector set.
def	LoadVolume
	Load 3d raster map (volume)
def	UnloadVolume
	Unload volume.
def	SetSurfaceTopo
	Set surface topography.
def	SetSurfaceColor
	Set surface color.
def	SetSurfaceMask
	Set surface mask.
def	SetSurfaceTransp
	Set surface mask.
def	SetSurfaceShine
	Set surface shininess.
def	SetSurfaceEmit
	Set surface emission.
def	SetSurfaceAttr
	Set surface attribute.
def	UnsetSurfaceMask
	Unset surface mask.
def	UnsetSurfaceTransp
	Unset surface transparency.
def	UnsetSurfaceEmit
	Unset surface emission.
def	UnsetSurfaceAttr
	Unset surface attribute.
def	SetSurfaceRes
	Set surface resolution.
def	SetSurfaceStyle
	Set draw style.
def	SetWireColor
	Set color of wire.
def	GetSurfacePosition
	Get surface position.
def	SetSurfacePosition
	Set surface position.
def	SetVectorLineMode
	Set mode of vector line overlay.
def	SetVectorLineHeight
	Set vector height above surface (lines)
def	SetVectorLineSurface
	Set reference surface of vector set (lines)
def	SetVectorPointMode
	Set mode of vector point overlay.
def	SetVectorPointHeight
	Set vector height above surface (points)
def	SetVectorPointSurface
	Set reference surface of vector set (points)
def	AddIsosurface
	Add new isosurface.
def	DeleteIsosurface
	Delete isosurface.
def	MoveIsosurface
	Move isosurface up/down in the list.
def	SetIsosurfaceColor
	Set isosurface color.
def	SetIsosurfaceMask
	Set isosurface mask.
def	SetIsosurfaceTransp
	Set isosurface transparency.
def	SetIsosurfaceShine
	Set isosurface shininess.
def	SetIsosurfaceEmit
	Set isosurface emission.
def	SetIsosurfaceAttr
	Set isosurface attribute.
def	UnsetIsosurfaceMask
	Unset isosurface mask.
def	UnsetIsosurfaceTransp
	Unset isosurface transparency.
def	UnsetIsosurfaceEmit
	Unset isosurface emission.
def	UnsetIsosurfaceAttr
	Unset surface attribute.
def	SetIsosurfaceMode
	Set draw mode for isosurfaces.
def	SetIsosurfaceRes
	Set draw resolution for isosurfaces.
def	SaveToFile
	Save current GL screen to ppm/tif file.
def	DrawLightingModel
	Draw lighting model.
def	SetFringe
	Set fringe.
def	GetPointOnSurface
	Get point on surface.
def	QueryMap
	Query surface map.
def	GetDistanceAlongSurface
	Get distance measured along surface.

Data Fields
	data_obj
	data
	width
	height
	showLight
	log

---

Detailed Description

Definition at line 63 of file wxnviz.py.

---

Constructor & Destructor Documentation

def gui_modules.wxnviz.Nviz.__init__	(		self,
			glog,
			gprogress
	)

Initialize Nviz class instance.

Parameters:

log	logging area

Definition at line 64 of file wxnviz.py.

References G_set_error_routine(), G_set_percent_routine(), GS_libinit(), and GVL_libinit().

def gui_modules.wxnviz.Nviz.__del__

(

self

)

Destroy Nviz class instance.

Definition at line 87 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.data, gui_modules.menuform.UpdateThread.data, gui_modules.vdigit.VDigitDuplicatesDialog.data, gui_modules.vdigit.CheckListFeature.data, gui_modules.gmodeler.ModelAction.data, gui_modules.gmodeler.ProcessModelFile.data, gui_modules.nviz_tools.ViewPositionWindow.data, gui_modules.nviz_tools.LightPositionWindow.data, gui_modules.wxnviz.Nviz.data_obj, G_unset_error_routine(), and G_unset_percent_routine().

---

Member Function Documentation

def gui_modules.wxnviz.Nviz.AddIsosurface	(		self,
			id,
			level
	)

Add new isosurface.

Parameters:

id	volume id
level	isosurface level (topography)

Returns:

-1 on failure

1 on success

Definition at line 853 of file wxnviz.py.

References GVL_isosurf_add(), GVL_isosurf_num_isosurfs(), GVL_isosurf_set_att_const(), and GVL_vol_exists().

def gui_modules.wxnviz.Nviz.DeleteIsosurface	(		self,
			id,
			isosurf_id
	)

Delete isosurface.

Parameters:

id	volume id
isosurf_id	isosurface id

Returns:

1 on success

-1 volume not found

-2 isosurface not found

-3 on failure

Definition at line 873 of file wxnviz.py.

References GVL_isosurf_del(), GVL_isosurf_num_isosurfs(), and GVL_vol_exists().

def gui_modules.wxnviz.Nviz.Draw	(		self,
			quick,
			quick_mode
	)

Draw canvas.

Draw quick mode:

• DRAW_QUICK_SURFACE
• DRAW_QUICK_VLINES
• DRAW_QUICK_VPOINTS
• DRAW_QUICK_VOLUME

Parameters:

quick	if true draw in wiremode
quick_mode	quick mode

Definition at line 155 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.data, gui_modules.menuform.UpdateThread.data, gui_modules.vdigit.VDigitDuplicatesDialog.data, gui_modules.vdigit.CheckListFeature.data, gui_modules.gmodeler.ModelAction.data, gui_modules.gmodeler.ProcessModelFile.data, gui_modules.nviz_tools.ViewPositionWindow.data, gui_modules.nviz_tools.LightPositionWindow.data, Nviz_draw_all(), Nviz_draw_cplane(), and Nviz_draw_quick().

Referenced by gui_modules.wxnviz.Nviz.SaveToFile().

def gui_modules.wxnviz.Nviz.DrawLightingModel

(

self

)

Draw lighting model.

Definition at line 1167 of file wxnviz.py.

References GS_draw_lighting_model(), and gui_modules.wxnviz.Nviz.showLight.

def gui_modules.wxnviz.Nviz.EraseMap

(

self

)

Erase map display (with background color)

Definition at line 176 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.data, gui_modules.menuform.UpdateThread.data, gui_modules.vdigit.VDigitDuplicatesDialog.data, gui_modules.vdigit.CheckListFeature.data, gui_modules.gmodeler.ModelAction.data, gui_modules.gmodeler.ProcessModelFile.data, gui_modules.nviz_tools.ViewPositionWindow.data, gui_modules.nviz_tools.LightPositionWindow.data, GS_clear(), and Nviz_get_bgcolor().

def gui_modules.wxnviz.Nviz.GetDistanceAlongSurface	(		self,
			sid,
			p1,
			p2,
			useExag = True
	)

Get distance measured along surface.

Definition at line 1223 of file wxnviz.py.

References GS_get_distance_alongsurf().

def gui_modules.wxnviz.Nviz.GetPointOnSurface	(		self,
			sx,
			sy
	)

Get point on surface.

Parameters:

sx,sy

canvas coordinates (LL)

Definition at line 1186 of file wxnviz.py.

References GS_get_selected_point_on_surface().

Referenced by gui_modules.wxnviz.Nviz.QueryMap().

def gui_modules.wxnviz.Nviz.GetSurfacePosition	(		self,
			id
	)

Get surface position.

Parameters:

id	surface id

Returns:

x,y,z

zero-length vector on error

Definition at line 681 of file wxnviz.py.

References GS_get_trans(), and GS_surf_exists().

def gui_modules.wxnviz.Nviz.InitView

(

self

)

Initialize view.

Definition at line 182 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.data, gui_modules.menuform.UpdateThread.data, gui_modules.vdigit.VDigitDuplicatesDialog.data, gui_modules.vdigit.CheckListFeature.data, gui_modules.gmodeler.ModelAction.data, gui_modules.gmodeler.ProcessModelFile.data, gui_modules.nviz_tools.ViewPositionWindow.data, gui_modules.nviz_tools.LightPositionWindow.data, GS_clear(), Nviz_color_from_str(), Nviz_get_bgcolor(), Nviz_init_data(), Nviz_init_view(), Nviz_set_bgcolor(), and Nviz_set_surface_attr_default().

def gui_modules.wxnviz.Nviz.LoadSurface	(		self,
			name,
			color_name,
			color_value
	)

Load raster map (surface)

Parameters:

name	raster map name
color_name	raster map for color (None for color_value)
color_value	color string (named color or RGB triptet)

Returns:

object id

-1 on failure

Definition at line 218 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.data, gui_modules.menuform.UpdateThread.data, gui_modules.vdigit.VDigitDuplicatesDialog.data, gui_modules.vdigit.CheckListFeature.data, gui_modules.gmodeler.ModelAction.data, gui_modules.gmodeler.ProcessModelFile.data, gui_modules.nviz_tools.ViewPositionWindow.data, gui_modules.nviz_tools.LightPositionWindow.data, G_find_cell2(), G_fully_qualified_name(), G_warning(), GS_delete_surface(), Nviz_color_from_str(), Nviz_new_map_obj(), Nviz_set_attr(), and Nviz_set_focus_map().

def gui_modules.wxnviz.Nviz.LoadVector	(		self,
			name,
			points
	)

Load vector map overlay.

Parameters:

name	vector map name
points	if true load 2d points rather then 2d lines

Returns:

object id

-1 on failure

Definition at line 287 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.data, gui_modules.menuform.UpdateThread.data, gui_modules.vdigit.VDigitDuplicatesDialog.data, gui_modules.vdigit.CheckListFeature.data, gui_modules.gmodeler.ModelAction.data, gui_modules.gmodeler.ProcessModelFile.data, gui_modules.nviz_tools.ViewPositionWindow.data, gui_modules.nviz_tools.LightPositionWindow.data, G_fully_qualified_name(), G_warning(), GS_get_surf_list(), GS_num_surfs(), GS_set_att_const(), and Nviz_new_map_obj().

def gui_modules.wxnviz.Nviz.LoadVolume	(		self,
			name,
			color_name,
			color_value
	)

Load 3d raster map (volume)

Parameters:

name	3d raster map name
color_name	3d raster map for color (None for color_value)
color_value	color string (named color or RGB triptet)

Returns:

object id

-1 on failure

Definition at line 345 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.data, gui_modules.menuform.UpdateThread.data, gui_modules.vdigit.VDigitDuplicatesDialog.data, gui_modules.vdigit.CheckListFeature.data, gui_modules.gmodeler.ModelAction.data, gui_modules.gmodeler.ProcessModelFile.data, gui_modules.nviz_tools.ViewPositionWindow.data, gui_modules.nviz_tools.LightPositionWindow.data, G_find_grid3(), G_fully_qualified_name(), G_warning(), GVL_delete_vol(), Nviz_color_from_str(), Nviz_new_map_obj(), and Nviz_set_attr().

def gui_modules.wxnviz.Nviz.MoveIsosurface	(		self,
			id,
			isosurf_id,
			up
	)

Move isosurface up/down in the list.

Parameters:

id	volume id
isosurf_id	isosurface id
up	if true move up otherwise down

Returns:

1 on success

-1 volume not found

-2 isosurface not found

-3 on failure

Definition at line 897 of file wxnviz.py.

References GVL_isosurf_move_down(), GVL_isosurf_move_up(), GVL_isosurf_num_isosurfs(), and GVL_vol_exists().

def gui_modules.wxnviz.Nviz.QueryMap	(		self,
			sx,
			sy
	)

Query surface map.

Parameters:

sx,sy

canvas coordinates (LL)

Definition at line 1202 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.GetPointOnSurface(), GS_get_cat_at_xy(), and GS_get_val_at_xy().

def gui_modules.wxnviz.Nviz.ResizeWindow	(		self,
			width,
			height
	)

GL canvas resized.

Parameters:

width	window width
height	window height

Returns:

1 on success

0 on failure (window resized by default to 20x20 px)

Definition at line 95 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.height, gui_modules.histogram.HistFrame.height, gui_modules.colorrules.ColorTable.height, gui_modules.render.Map.height, gui_modules.gcpmapdisp.MapFrame.height, gui_modules.mapdisp.MapFrame.height, gui_modules.gdialogs.ImageSizeDialog.height, gui_modules.gmodeler.ModelCondition.height, Nviz_resize_window(), gui_modules.wxnviz.Nviz.width, gui_modules.colorrules.ColorTable.width, gui_modules.render.Map.width, gui_modules.gdialogs.ImageSizeDialog.width, and gui_modules.gmodeler.ModelCondition.width.

Referenced by gui_modules.wxnviz.Nviz.SaveToFile().

def gui_modules.wxnviz.Nviz.SaveToFile	(		self,
			filename,
			width = 20,
			height = 20,
			itype = 'ppm'
	)

Save current GL screen to ppm/tif file.

Parameters:

filename	file name
width	image width
height	image height
itype	image type ('ppm' or 'tif')

Definition at line 1146 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.data, gui_modules.menuform.UpdateThread.data, gui_modules.vdigit.VDigitDuplicatesDialog.data, gui_modules.vdigit.CheckListFeature.data, gui_modules.gmodeler.ModelAction.data, gui_modules.gmodeler.ProcessModelFile.data, gui_modules.nviz_tools.ViewPositionWindow.data, gui_modules.nviz_tools.LightPositionWindow.data, gui_modules.histogram.BufferedWindow.Draw(), gui_modules.wxnviz.Nviz.Draw(), gui_modules.mapdisp_window.BufferedWindow.Draw(), gui_modules.colorrules.BufferedWindow.Draw(), gui_modules.psmap.PsMapBufferedWindow.Draw(), gui_modules.nviz_tools.PositionWindow.Draw(), GS_clear(), GS_write_ppm(), GS_write_tif(), gui_modules.wxnviz.Nviz.height, gui_modules.histogram.HistFrame.height, gui_modules.colorrules.ColorTable.height, gui_modules.render.Map.height, gui_modules.gcpmapdisp.MapFrame.height, gui_modules.mapdisp.MapFrame.height, gui_modules.gdialogs.ImageSizeDialog.height, gui_modules.gmodeler.ModelCondition.height, Nviz_get_bgcolor(), gui_modules.wxnviz.Nviz.ResizeWindow(), gui_modules.wxnviz.Nviz.width, gui_modules.colorrules.ColorTable.width, gui_modules.render.Map.width, gui_modules.gdialogs.ImageSizeDialog.width, and gui_modules.gmodeler.ModelCondition.width.

def gui_modules.wxnviz.Nviz.SetBgColor	(		self,
			color_str
	)

Set background color.

Parameters:

color_str

color string

Definition at line 198 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.data, gui_modules.menuform.UpdateThread.data, gui_modules.vdigit.VDigitDuplicatesDialog.data, gui_modules.vdigit.CheckListFeature.data, gui_modules.gmodeler.ModelAction.data, gui_modules.gmodeler.ProcessModelFile.data, gui_modules.nviz_tools.ViewPositionWindow.data, gui_modules.nviz_tools.LightPositionWindow.data, Nviz_color_from_str(), and Nviz_set_bgcolor().

def gui_modules.wxnviz.Nviz.SetFringe	(		self,
			sid,
			color,
			elev,
			nw = False,
			ne = False,
			sw = False,
			se = False
	)

Set fringe.

Parameters:

sid	surface id
color	color
elev	elevation (height)
nw,ne,sw,se	fringe edges (turn on/off)

Definition at line 1172 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.data, gui_modules.menuform.UpdateThread.data, gui_modules.vdigit.VDigitDuplicatesDialog.data, gui_modules.vdigit.CheckListFeature.data, gui_modules.gmodeler.ModelAction.data, gui_modules.gmodeler.ProcessModelFile.data, gui_modules.nviz_tools.ViewPositionWindow.data, gui_modules.nviz_tools.LightPositionWindow.data, Nviz_color_from_str(), and Nviz_set_fringe().

def gui_modules.wxnviz.Nviz.SetIsosurfaceAttr	(		self,
			id,
			isosurf_id,
			attr,
			map,
			value
	)

Set isosurface attribute.

Parameters:

id	volume id
isosurf_id	isosurface id (0 - MAX_ISOSURFS)
attr	attribute desc
map	if true use map otherwise constant
value	map name of value

Returns:

1 on success

-1 volume not found

-2 isosurface not found

-3 setting attributes failed

Definition at line 1002 of file wxnviz.py.

References GVL_isosurf_num_isosurfs(), GVL_isosurf_set_att_const(), GVL_isosurf_set_att_map(), GVL_vol_exists(), and Nviz_color_from_str().

Referenced by gui_modules.wxnviz.Nviz.SetIsosurfaceColor(), gui_modules.wxnviz.Nviz.SetIsosurfaceEmit(), gui_modules.wxnviz.Nviz.SetIsosurfaceMask(), gui_modules.wxnviz.Nviz.SetIsosurfaceShine(), and gui_modules.wxnviz.Nviz.SetIsosurfaceTransp().

def gui_modules.wxnviz.Nviz.SetIsosurfaceColor	(		self,
			id,
			isosurf_id,
			map,
			value
	)

Set isosurface color.

Parameters:

id	volume id
isosurf_id	isosurface id (0 - MAX_ISOSURFS)
map	if true use map otherwise constant
value	map name of value

Returns:

1 on success

-1 volume not found

-2 isosurface not found

-3 on failure

Definition at line 925 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.SetIsosurfaceAttr().

def gui_modules.wxnviz.Nviz.SetIsosurfaceEmit	(		self,
			id,
			isosurf_id,
			map,
			value
	)

Set isosurface emission.

Parameters:

id	volume id
isosurf_id	isosurface id (0 - MAX_ISOSURFS)
map	if true use map otherwise constant
value	map name of value

Returns:

1 on success

-1 volume not found

-2 isosurface not found

-3 on failure

Definition at line 987 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.SetIsosurfaceAttr().

def gui_modules.wxnviz.Nviz.SetIsosurfaceMask	(		self,
			id,
			isosurf_id,
			invert,
			value
	)

Set isosurface mask.

Todo:

invert

Parameters:

id	volume id
isosurf_id	isosurface id (0 - MAX_ISOSURFS)
invert	true for invert mask
value	map name to be used for mask

Returns:

1 on success

-1 volume not found

-2 isosurface not found

-3 on failure

Definition at line 940 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.SetIsosurfaceAttr().

def gui_modules.wxnviz.Nviz.SetIsosurfaceMode	(		self,
			id,
			mode
	)

Set draw mode for isosurfaces.

Parameters:

mode

Returns:

1 on success

-1 volume set not found

-2 on failure

Definition at line 1108 of file wxnviz.py.

References GVL_isosurf_set_drawmode(), and GVL_vol_exists().

def gui_modules.wxnviz.Nviz.SetIsosurfaceRes	(		self,
			id,
			res
	)

Set draw resolution for isosurfaces.

Parameters:

res	resolution value

Returns:

1 on success

-1 volume set not found

-2 on failure

Definition at line 1127 of file wxnviz.py.

References GVL_isosurf_set_drawres(), and GVL_vol_exists().

def gui_modules.wxnviz.Nviz.SetIsosurfaceShine	(		self,
			id,
			isosurf_id,
			map,
			value
	)

Set isosurface shininess.

Parameters:

id	volume id
isosurf_id	isosurface id (0 - MAX_ISOSURFS)
map	if true use map otherwise constant
value	map name of value

Returns:

1 on success

-1 volume not found

-2 isosurface not found

-3 on failure

Definition at line 972 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.SetIsosurfaceAttr().

def gui_modules.wxnviz.Nviz.SetIsosurfaceTransp	(		self,
			id,
			isosurf_id,
			map,
			value
	)

Set isosurface transparency.

Parameters:

id	volume id
isosurf_id	isosurface id (0 - MAX_ISOSURFS)
map	if true use map otherwise constant
value	map name of value

Returns:

1 on success

-1 volume not found

-2 isosurface not found

-3 on failure

Definition at line 957 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.SetIsosurfaceAttr().

def gui_modules.wxnviz.Nviz.SetLight	(		self,
			x,
			y,
			z,
			color,
			bright,
			ambient,
			w = 0,
			lid = 1
	)

Change lighting settings.

Parameters:

x,y,z	position
color	light color (as string)
bright	light brightness
ambient	light ambient
w	local coordinate (default to 0)

Definition at line 205 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.data, gui_modules.menuform.UpdateThread.data, gui_modules.vdigit.VDigitDuplicatesDialog.data, gui_modules.vdigit.CheckListFeature.data, gui_modules.gmodeler.ModelAction.data, gui_modules.gmodeler.ProcessModelFile.data, gui_modules.nviz_tools.ViewPositionWindow.data, gui_modules.nviz_tools.LightPositionWindow.data, Nviz_set_light_ambient(), Nviz_set_light_bright(), Nviz_set_light_color(), and Nviz_set_light_position().

def gui_modules.wxnviz.Nviz.SetSurfaceAttr	(		self,
			id,
			attr,
			map,
			value
	)

Set surface attribute.

Parameters:

id	surface id
attr	attribute desc
map	if true use map otherwise constant
value	map name of value

Returns:

1 on success

-1 surface not found

-2 setting attributes failed

Definition at line 490 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.data, gui_modules.menuform.UpdateThread.data, gui_modules.vdigit.VDigitDuplicatesDialog.data, gui_modules.vdigit.CheckListFeature.data, gui_modules.gmodeler.ModelAction.data, gui_modules.gmodeler.ProcessModelFile.data, gui_modules.nviz_tools.ViewPositionWindow.data, gui_modules.nviz_tools.LightPositionWindow.data, GS_surf_exists(), Nviz_color_from_str(), and Nviz_set_attr().

Referenced by gui_modules.wxnviz.Nviz.SetSurfaceColor(), gui_modules.wxnviz.Nviz.SetSurfaceEmit(), gui_modules.wxnviz.Nviz.SetSurfaceMask(), gui_modules.wxnviz.Nviz.SetSurfaceShine(), gui_modules.wxnviz.Nviz.SetSurfaceTopo(), and gui_modules.wxnviz.Nviz.SetSurfaceTransp().

def gui_modules.wxnviz.Nviz.SetSurfaceColor	(		self,
			id,
			map,
			value
	)

Set surface color.

Parameters:

id	surface id
map	if true use map otherwise constant
value	map name of value

Returns:

1 on success

-1 surface not found

-2 setting attributes failed

Definition at line 421 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.SetSurfaceAttr().

def gui_modules.wxnviz.Nviz.SetSurfaceEmit	(		self,
			id,
			map,
			value
	)

Set surface emission.

Parameters:

id	surface id
map	if true use map otherwise constant
value	map name of value

Returns:

1 on success

-1 surface not found

-2 setting attributes failed

Definition at line 477 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.SetSurfaceAttr().

def gui_modules.wxnviz.Nviz.SetSurfaceMask	(		self,
			id,
			invert,
			value
	)

Set surface mask.

Todo:

invert

Parameters:

id	surface id
invert	if true invert mask
value	map name of value

Returns:

1 on success

-1 surface not found

-2 setting attributes failed

Definition at line 434 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.SetSurfaceAttr().

def gui_modules.wxnviz.Nviz.SetSurfacePosition	(		self,
			id,
			x,
			y,
			z
	)

Set surface position.

Parameters:

id	surface id
x,y,z	translation values

Returns:

1 on success

-1 surface not found

-2 setting position failed

Definition at line 700 of file wxnviz.py.

References GS_set_trans(), and GS_surf_exists().

def gui_modules.wxnviz.Nviz.SetSurfaceRes	(		self,
			id,
			fine,
			coarse
	)

Set surface resolution.

Parameters:

id	surface id
fine	x/y fine resolution
coarse	x/y coarse resolution

Returns:

1 on success

-1 surface not found

-2 setting attributes failed

Definition at line 582 of file wxnviz.py.

References GS_set_drawres(), GS_setall_drawres(), and GS_surf_exists().

def gui_modules.wxnviz.Nviz.SetSurfaceShine	(		self,
			id,
			map,
			value
	)

Set surface shininess.

Parameters:

id	surface id
map	if true use map otherwise constant
value	map name of value

Returns:

1 on success

-1 surface not found

-2 setting attributes failed

Definition at line 464 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.SetSurfaceAttr().

def gui_modules.wxnviz.Nviz.SetSurfaceStyle	(		self,
			id,
			style
	)

Set draw style.

Draw styles:

• DM_GOURAUD
• DM_FLAT
• DM_FRINGE
• DM_WIRE
• DM_COL_WIRE
• DM_POLY
• DM_WIRE_POLY
• DM_GRID_WIRE
• DM_GRID_SURF

Parameters:

id	surface id (<= 0 for all)
style	draw style

Returns:

1 on success

-1 surface not found

-2 setting attributes failed

Definition at line 607 of file wxnviz.py.

References GS_set_drawmode(), GS_setall_drawmode(), and GS_surf_exists().

def gui_modules.wxnviz.Nviz.SetSurfaceTopo	(		self,
			id,
			map,
			value
	)

Set surface topography.

Parameters:

id	surface id
map	if true use map otherwise constant
value	map name of value

Returns:

1 on success

-1 surface not found

-2 setting attributes failed

Definition at line 408 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.SetSurfaceAttr().

def gui_modules.wxnviz.Nviz.SetSurfaceTransp	(		self,
			id,
			map,
			value
	)

Set surface mask.

Todo:

invert

Parameters:

id	surface id
map	if true use map otherwise constant
value	map name of value

Returns:

1 on success

-1 surface not found

-2 setting attributes failed

Definition at line 449 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.SetSurfaceAttr().

def gui_modules.wxnviz.Nviz.SetVectorLineHeight	(		self,
			id,
			height
	)

Set vector height above surface (lines)

Parameters:

id	vector set id
height

Returns:

-1 vector set not found

1 on success

Definition at line 746 of file wxnviz.py.

References GV_set_trans(), and GV_vect_exists().

def gui_modules.wxnviz.Nviz.SetVectorLineMode	(		self,
			id,
			color_str,
			width,
			flat
	)

Set mode of vector line overlay.

Parameters:

id	vector id
color_str	color string
width	line width
flat	display flat or on surface

Returns:

-1 vector set not found

-2 on failure

1 on success

Definition at line 720 of file wxnviz.py.

References GV_set_vectmode(), GV_vect_exists(), and Nviz_color_from_str().

def gui_modules.wxnviz.Nviz.SetVectorLineSurface	(		self,
			id,
			surf_id
	)

Set reference surface of vector set (lines)

Parameters:

id	vector set id
surf_id	surface id

Returns:

1 on success

-1 vector set not found

-2 surface not found

-3 on failure

Definition at line 765 of file wxnviz.py.

References GS_surf_exists(), GV_select_surf(), and GV_vect_exists().

def gui_modules.wxnviz.Nviz.SetVectorPointHeight	(		self,
			id,
			height
	)

Set vector height above surface (points)

Parameters:

id	vector set id
height

Returns:

-1 vector set not found

1 on success

Definition at line 812 of file wxnviz.py.

References GP_set_trans(), and GP_site_exists().

def gui_modules.wxnviz.Nviz.SetVectorPointMode	(		self,
			id,
			color_str,
			width,
			size,
			marker
	)

Set mode of vector point overlay.

Parameters:

id	vector id
color_str	color string
width	line width
flat

Returns:

-1 vector set not found

Definition at line 787 of file wxnviz.py.

References GP_site_exists(), and Nviz_color_from_str().

def gui_modules.wxnviz.Nviz.SetVectorPointSurface	(		self,
			id,
			surf_id
	)

Set reference surface of vector set (points)

Parameters:

id	vector set id
surf_id	surface id

Returns:

1 on success

-1 vector set not found

-2 surface not found

-3 on failure

Definition at line 831 of file wxnviz.py.

References GP_select_surf(), GP_site_exists(), and GS_surf_exists().

def gui_modules.wxnviz.Nviz.SetView	(		self,
			x,
			y,
			height,
			persp,
			twist
	)

Change view settings.

Parameters:

x,y	position
height
persp	perpective
twist

Definition at line 130 of file wxnviz.py.

References Nviz_set_viewpoint_height(), Nviz_set_viewpoint_persp(), Nviz_set_viewpoint_position(), and Nviz_set_viewpoint_twist().

def gui_modules.wxnviz.Nviz.SetViewDefault

(

self

)

Set default view (based on loaded data)

Returns:

z-exag value, default, min and max height

Definition at line 110 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.data, gui_modules.menuform.UpdateThread.data, gui_modules.vdigit.VDigitDuplicatesDialog.data, gui_modules.vdigit.CheckListFeature.data, gui_modules.gmodeler.ModelAction.data, gui_modules.gmodeler.ProcessModelFile.data, gui_modules.nviz_tools.ViewPositionWindow.data, gui_modules.nviz_tools.LightPositionWindow.data, Nviz_change_exag(), Nviz_get_exag(), and Nviz_get_exag_height().

def gui_modules.wxnviz.Nviz.SetWireColor	(		self,
			id,
			color_str
	)

Set color of wire.

Todo:

all

Parameters:

surface	id (< 0 for all)
color	color string (R:G:B)

Returns:

1 on success

-1 surface not found

-2 setting attributes failed

1 on success

0 on failure

Definition at line 645 of file wxnviz.py.

References G_free(), GS_get_surf_list(), GS_set_wire_color(), GS_surf_exists(), and Nviz_color_from_str().

def gui_modules.wxnviz.Nviz.SetZExag	(		self,
			z_exag
	)

Set z-exag value.

Parameters:

z_exag

value

Returns:

1

Definition at line 145 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.data, gui_modules.menuform.UpdateThread.data, gui_modules.vdigit.VDigitDuplicatesDialog.data, gui_modules.vdigit.CheckListFeature.data, gui_modules.gmodeler.ModelAction.data, gui_modules.gmodeler.ProcessModelFile.data, gui_modules.nviz_tools.ViewPositionWindow.data, gui_modules.nviz_tools.LightPositionWindow.data, and Nviz_change_exag().

def gui_modules.wxnviz.Nviz.UnloadSurface	(		self,
			id
	)

Unload surface.

Parameters:

id	surface id

Returns:

1 on success

0 on failure

Definition at line 269 of file wxnviz.py.

References GS_delete_surface(), and GS_surf_exists().

def gui_modules.wxnviz.Nviz.UnloadVector	(		self,
			id,
			points
	)

Unload vector set.

Parameters:

id	vector set id
points	vector points or lines set

Returns:

1 on success

0 on failure

Definition at line 321 of file wxnviz.py.

References GP_delete_site(), GP_site_exists(), GV_delete_vector(), and GV_vect_exists().

def gui_modules.wxnviz.Nviz.UnloadVolume	(		self,
			id
	)

Unload volume.

Parameters:

id

volume id

Returns:

1 on success

0 on failure

Definition at line 390 of file wxnviz.py.

References GVL_delete_vol(), and GVL_vol_exists().

def gui_modules.wxnviz.Nviz.UnsetIsosurfaceAttr	(		self,
			id,
			isosurf_id,
			attr
	)

Unset surface attribute.

Parameters:

id	surface id
isosurf_id	isosurface id (0 - MAX_ISOSURFS)
attr	attribute descriptor

Returns:

1 on success

-1 volume not found

-2 isosurface not found

-2 on failure

Definition at line 1080 of file wxnviz.py.

References GVL_isosurf_num_isosurfs(), GVL_isosurf_unset_att(), and GVL_vol_exists().

Referenced by gui_modules.wxnviz.Nviz.UnsetIsosurfaceEmit(), gui_modules.wxnviz.Nviz.UnsetIsosurfaceMask(), and gui_modules.wxnviz.Nviz.UnsetIsosurfaceTransp().

def gui_modules.wxnviz.Nviz.UnsetIsosurfaceEmit	(		self,
			id,
			isosurf_id
	)

Unset isosurface emission.

Parameters:

id	volume id
isosurf_id	isosurface id (0 - MAX_ISOSURFS)

Returns:

1 on success

-1 volume not found

-2 isosurface not found

-3 setting attributes failed

Definition at line 1067 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.UnsetIsosurfaceAttr().

def gui_modules.wxnviz.Nviz.UnsetIsosurfaceMask	(		self,
			id,
			isosurf_id
	)

Unset isosurface mask.

Parameters:

id	volume id
isosurf_id	isosurface id (0 - MAX_ISOSURFS)

Returns:

1 on success

-1 volume not found

-2 isosurface not found

-3 setting attributes failed

Definition at line 1041 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.UnsetIsosurfaceAttr().

def gui_modules.wxnviz.Nviz.UnsetIsosurfaceTransp	(		self,
			id,
			isosurf_id
	)

Unset isosurface transparency.

Parameters:

id	volume id
isosurf_id	isosurface id (0 - MAX_ISOSURFS)

Returns:

1 on success

-1 volume not found

-2 isosurface not found

-3 setting attributes failed

Definition at line 1054 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.UnsetIsosurfaceAttr().

def gui_modules.wxnviz.Nviz.UnsetSurfaceAttr	(		self,
			id,
			attr
	)

Unset surface attribute.

Parameters:

id	surface id
attr	attribute descriptor

Returns:

1 on success

-1 surface not found

-2 setting attributes failed

Definition at line 559 of file wxnviz.py.

References GS_surf_exists(), and Nviz_unset_attr().

Referenced by gui_modules.wxnviz.Nviz.UnsetSurfaceEmit(), gui_modules.wxnviz.Nviz.UnsetSurfaceMask(), and gui_modules.wxnviz.Nviz.UnsetSurfaceTransp().

def gui_modules.wxnviz.Nviz.UnsetSurfaceEmit	(		self,
			id
	)

Unset surface emission.

Parameters:

id	surface id

Returns:

1 on success

-1 surface not found

-2 setting attributes failed

Definition at line 548 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.UnsetSurfaceAttr().

def gui_modules.wxnviz.Nviz.UnsetSurfaceMask	(		self,
			id
	)

Unset surface mask.

Parameters:

id	surface id

Returns:

1 on success

-1 surface not found

-2 setting attributes failed

-1 on failure

Definition at line 525 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.UnsetSurfaceAttr().

def gui_modules.wxnviz.Nviz.UnsetSurfaceTransp	(		self,
			id
	)

Unset surface transparency.

Parameters:

id	surface id

Returns:

1 on success

-1 surface not found

-2 setting attributes failed

Definition at line 537 of file wxnviz.py.

References gui_modules.wxnviz.Nviz.UnsetSurfaceAttr().

---

Field Documentation

gui_modules.wxnviz.Nviz.data

Definition at line 81 of file wxnviz.py.

Referenced by gui_modules.wxnviz.Nviz.__del__(), gui_modules.wxnviz.Nviz.Draw(), gui_modules.wxnviz.Nviz.EraseMap(), gui_modules.wxnviz.Nviz.InitView(), gui_modules.wxnviz.Nviz.LoadSurface(), gui_modules.wxnviz.Nviz.LoadVector(), gui_modules.wxnviz.Nviz.LoadVolume(), gui_modules.nviz_tools.PositionWindow.PostDraw(), gui_modules.wxnviz.Nviz.SaveToFile(), gui_modules.wxnviz.Nviz.SetBgColor(), gui_modules.wxnviz.Nviz.SetFringe(), gui_modules.wxnviz.Nviz.SetLight(), gui_modules.wxnviz.Nviz.SetSurfaceAttr(), gui_modules.wxnviz.Nviz.SetViewDefault(), gui_modules.wxnviz.Nviz.SetZExag(), and gui_modules.nviz_tools.PositionWindow.UpdatePos().

gui_modules.wxnviz.Nviz.data_obj

Definition at line 80 of file wxnviz.py.

Referenced by gui_modules.wxnviz.Nviz.__del__().

gui_modules.wxnviz.Nviz.height

Definition at line 82 of file wxnviz.py.

Referenced by gui_modules.wxnviz.Nviz.ResizeWindow(), and gui_modules.wxnviz.Nviz.SaveToFile().

gui_modules.wxnviz.Nviz.log

Definition at line 93 of file wxnviz.py.

gui_modules.wxnviz.Nviz.showLight

Definition at line 83 of file wxnviz.py.

Referenced by gui_modules.wxnviz.Nviz.DrawLightingModel().

gui_modules.wxnviz.Nviz.width

Definition at line 82 of file wxnviz.py.

Referenced by gui_modules.wxnviz.Nviz.ResizeWindow(), and gui_modules.wxnviz.Nviz.SaveToFile().

---

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

• wxnviz.py