model.view()

Create and manage views.

Syntax

model.view().create(<vtag>,<gtag>)

model.view().create(<vtag>,<viewdim>)

model.view().create(<vtag>,<gtag>,<workplane>)

model.view(<vtag>).set(<pname>,<pvalue>)

model.view(<vtag>).getType(<pname>)

 

model.view(<vtag>).axis().set(<pname>, <pvalue>)

model.view(<vtag>).axis().getType(<pname>)

model.view(<vtag>).camera().set(<pname>, <pvalue>)

model.view(<vtag>).camera().getType(<pname>)

model.view(<vtag>).light().create(<ltag>, <ltype>)

model.view(<vtag>).light(<ltag>).set(<pname>, <pvalue>)

model.view(<vtag>).light(<ltag>).getType(<pname>)

model.view(<vtag>).hideObjects().create(<htag>)

model.view(<vtag>).hideObjects(<htag>).set(<pname>, <pvalue>)

model.view(<vtag>).hideObjects(<htag>).getType(<pname>)

model.view(<vtag>).hideEntities().create(<htag>)

model.view(<vtag>).hideEntities(<htag>).set(<pname>, <pvalue>)

model.view(<vtag>).hideEntities(<htag>).getType(<pname>)

model.view(<vtag>).hideMesh().create(<htag>)

model.view(<vtag>).hideMesh(<htag>).set(<pname>, <pvalue>)

model.view(<vtag>).hideMesh(<htag>).getType(<pname>)

Description

View Settings

model.view() returns a list of view that can be used when viewing geometry/mesh and plot groups. Each view has an axis and some properties on the top level. In 3D a view also has a camera and a list of lights. All views also have a list of hide features.

 model.view().create(<vtag>,<gtag>) creates a view tied to the geometry with the given tag. The dimension of the view is the same as the dimension for the geometry.

model.view().create(<vtag>,<viewdim>) creates a view with the given tag for the given dimension (1, 2, or 3). These views are not tied to any geometry and show up under the Views node under Results in the COMSOL Desktop.

model.view().create(<vtag>,<gtag>,<workplane>) creates a view tied to the work plane with the given tag in the geometry sequence with the given tag. The dimension of the view is 2.

model.view(<vtag>).set(<pname>,<pvalue>) sets the given property to the given value.

model.view(<vtag>).getType(<pname>) returns the property with the given name of type Type.

Table 2-80: view properties

Name	value	dimensions	description
default	on|off	1, 2, 3	If this is the default view to use when viewing the geometry and mesh.
headlight	on|off	3	If the light in the camera should be turned on.
locked	on|off	1, 2, 3	If the settings should be updated from interactive changes or not.
scenelight	on|off	3	If the background lights as specified by the added lights should be turned on.
viewscaletype	none|automatic|manual	2, 3	Control the view scale to achieve a suitable axis scaling (default: None).
wireframe	on|off	3	If wireframe rendering should be used.
xscale	double	2, 3	Scaling factor for x-axis when using a manual view scale.
yscale	double	2, 3	Scaling factor for y-axis when using a manual view scale.
zscale	double	3	Scaling factor for z-axis when using a manual view scale.

Axis Settings

The axis settings apply to 2D views with an x- and a y-axis.

model.view(<vtag>).axis().set(<pname>, <pvalue>) sets the given axis property to the given value. Which axis properties that are available in the different dimensions are given in the table below.

model.view(<vtag>).axis().getType(<pname>) returns the axis property with the given name.

Table 2-81: axis properties

Name	value	dimensions	description
auto	on|off	1, 2, 3	Set if axis settings should be automatically stored and updated from interactive changes using mouse and toolbar buttons.
equal	on|off	2, 3	Should the same scaling be used for all directions.
logx	on|off	1	Should log scale be used for the x-axis.
logy	on|off	1	Should log scale be used for the y-axis.
manualspacing	on|off	2	Should manual spacing be used for x and y grid lines.
manuallimits	on|off	1, 2, 3	Should manual axis limits be used. If not a zoom extents is performed each time something is plotted into the axis.
xextra	double array	2	An array with extra x grid lines.
xmax	double	1, 2, 3	The maximum x-coordinate.
xspacing	double	2	Manual spacing for x grid lines.
yextra	double array	2	An array with extra y grid lines.
ymin	double	2, 3	The minimum y-coordinate.
ymax	double	2, 3	The maximum y-coordinate.
yspacing	double	2	Manual spacing for y grid lines.
zmin	double	3	The minimum z-coordinate.
zmax	double	3	The maximum z-coordinate.

Camera Settings

These settings apply to the camera for 3D views.

model.view(<vtag>).camera().set(<pname>, <pvalue>) sets the given camera property to the given value.

model.view(<vtag>).camera().getType(<pname>) returns the camera property with the given name.

Table 2-82: Camera properties

Name	value	description
projection	perspective| orthographic	Use perspective or orthographic projection.
manualspacing	on|off	Should manual spacing be used for grid lines.
position	double array	The position of the camera.
target	double array	The point the camera looks at.
up	double array	The up direction.
rotationpoint	double array	The center of rotation.
xextra	double array	An array with extra x grid lines.
xspacing	double	Manual spacing for x grid lines.
yextra	double array	An array with extra y grid lines.
yspacing	double	Manual spacing for y grid lines.
zextra	double array	An array with extra z grid lines.
zspacing	double	Manual spacing for z grid lines.
zoomanglefull	double	The full field of view angle in degrees.

Light Settings

These settings control the different types of lighting — direction light, spotlight, head light, and point light — that you can add to a 3D view.

model.view(<vtag>).light().create(<ltag>,<ltype>) creates a light with the given tag and type. <ltype> can be any of 'DirectionalLight', 'PointLight', 'SpotLight', and 'HeadLight'.

model.view(<vtag>).light(<ltag>).set(<pname>,<pvalue>) sets the given light property to the given value. Different properties are available for the different types of lights according to the table below.

model.view(<vtag>).light(<ltag>).getType(<pname>) returns the light property with the given name.

Table 2-83: light properties

Name	value	light types	description
color	string or RGB triplet	all	The color of the light.
cameracoord	on|off	all	If the light should be defined in the camera coordinate system or the world coordinate system.
direction	double array	DirectionalLight, SpotLight	The direction from which the light shines or is directed at.
position	double array	PointLight, SpotLight	The position from which the light shines.
spreadangle	double	SpotLight	The spread angle for the light.

Hiding Geometry Objects, Geometric Entities, and Imported Meshes

model.view(<vtag>).hideObjects().create(<htag>) creates a hide feature of geometric objects in the geometry sequence. The API for controlling it is similar to the API for selection in the geometry sequence; see Geometry Object Selection Methods under model.geom().

model.view(<vtag>).hideEntities().create(<htag>) creates a hide feature of geometric entities in the analyzed geometry used, for example, for the physics. The API for controlling it is similar to the API for selections on the finalized geometry; see model.selection().

model.view(<vtag>).hideMesh().create(<htag>) creates a hide feature of geometric entities in the analyzed geometry from an imported mesh used, for example, for the physics. The API for controlling it is similar to the API for selections on the finalized geometry; see model.selection(). For example, the following code hides boundary 4 in the geometry based on the mesh in mesh1:

// Create mesh hide object in view 1

model.view("view1").hideMesh().create("hide1");

// Select mesh1

model.view("view1").hideMesh("hide1").mesh("mesh1");

// Hide boundary 4 (3D is assumed)

model.view("view1").hideMesh("hide1").geom(2).set(4);

See Also

model.result()