surf_plot


Synopsis

produce a 3D or 2D surface by extruding 2D|1D mesh according to data values

Input Ports

in_field

1D|2D any mesh + Node_Data

ui_parent

user interface parent object

 

Parameters

data component

UIradioBoxLabel

scalar component to be used as additional dimension

scale

UIslider

scale for additional dimension

offset

UIslider

moves surface parallel to itself

 

Output Ports

out_fld

2D|3D same mesh + Node_Data

out_obj

output renderable object

 

Description

surf_plot creates a 3D or 2D mesh whose height at each point is proportional to the scalar data value at that node location in the original field. 2D input produces a 3D mesh. 1D input produces a 2D output.

Input Ports

in_field

The input is a field of any mesh type and any Node_Data. The field's mesh must have nspace=1 or 2. However, no checking is done to enforce this restriction. (Inputting an nspace=3 mesh will not generate a picture.) The Node_Data must contain at least one scalar component.

ui_parent

A port to connect to a user interface object that contains the macro's widgets. By default, it is connected to the default user interface object in the application in which the macro is instanced. (This default connection is not drawn.)

Parameters

data component

UIradioBoxLabel. Radio buttons to pick which of the input's data components to use to set the mesh height. The default is the first (0th) component. You must select a scalar component. If node data labels are present, they are displayed.

scale

UIslider. A float slider to scale the height (scale*component values). The default is 1.0. The range is -10.0 to 10.0.

offset

UIslider. A float slider that raises or lowers the resulting mesh with respect to the input mesh. The default is 0.0. The range is unbounded.

Output Ports

out_fld

The output is a mesh of the same type as the input mesh, with nspace+1, whose coordinate values represent the projected, scaled, and offset surface. Its Node_Data contains the data in the selected component.

out_obj

This is a renderable version of the output field.

Example

Libraries.Examples.Visualization.Surf_plot
examples/splot.v

File

v/modules.v

See also

Not applicable.