Top | ![]() |
![]() |
![]() |
![]() |
GtkWidget * | gwy_3d_view_new () |
const gchar * | gwy_3d_view_get_setup_prefix () |
void | gwy_3d_view_set_setup_prefix () |
const gchar * | gwy_3d_view_get_data_key () |
void | gwy_3d_view_set_data_key () |
void | gwy_3d_view_set_ovlay () |
const gchar * | gwy_3d_view_get_gradient_key () |
void | gwy_3d_view_set_gradient_key () |
const gchar * | gwy_3d_view_get_material_key () |
void | gwy_3d_view_set_material_key () |
guint | gwy_3d_view_get_reduced_size () |
void | gwy_3d_view_set_reduced_size () |
Gwy3DMovement | gwy_3d_view_get_movement_type () |
void | gwy_3d_view_set_movement_type () |
GdkPixbuf * | gwy_3d_view_get_pixbuf () |
GdkPixbuf * | gwy_3d_view_get_pixbuf_with_alpha () |
Gwy3DLabel * | gwy_3d_view_get_label () |
Gwy3DSetup * | gwy_3d_view_get_setup () |
GwyContainer * | gwy_3d_view_get_data () |
void | gwy_3d_view_get_scale_range () |
void | gwy_3d_view_set_scale_range () |
void | gwy_3d_view_class_disable_axis_drawing () |
const gchar * | gwy_3d_view_get_mask_key () |
void | gwy_3d_view_set_mask_key () |
char * | data-key | Read / Write |
char * | gradient-key | Read / Write |
char * | mask-key | Read / Write |
char * | material-key | Read / Write |
Gwy3DMovement | movement-type | Read / Write |
guint | reduced-size | Read / Write |
char * | setup-prefix | Read / Write |
Gwy3DView displays a data field as a threedimensional heightfield using OpenGL. You can create a new 3D view for
a data container with gwy_3d_view_new()
. By default, it inherits properties like palette from data view settings, but supports separate settings -- see
gwy_3d_view_set_gradient_key()
et al.
Gwy3DView allows the user to interactively rotate, scale, z-scale the data or move lights, depending on its movement state. There are no controls provided for mode change, you have to provide
some yourself and set the movement mode with gwy_3d_view_set_movement_type()
.
You have initialize GtkGLExt with gtk_gl_init_check()
and then Gwyddion's OpenGL with gwy_widgets_gl_init()
before
you can use Gwy3DView. These functions may not always succeed, see their description for more. If OpenGL
initialization fails (possibly because its support was not compiled in) Gwy3DView cannot be even instantiated.
GtkWidget *
gwy_3d_view_new (GwyContainer *data
);
Creates a new threedimensional OpenGL display of data
.
The widget is initialized from container data
.
const gchar *
gwy_3d_view_get_setup_prefix (Gwy3DView *gwy3dview
);
Gets prefix identifying 3D view setup in the container.
void gwy_3d_view_set_setup_prefix (Gwy3DView *gwy3dview
,const gchar *key
);
Sets the prefix of 3D view parameters in the container.
gwy3dview |
A 3D data view widget. |
|
key |
Container string prefix for keys identifying the view setup parameters. The Gwy3DSetup is stored at key
|
const gchar *
gwy_3d_view_get_data_key (Gwy3DView *gwy3dview
);
Gets the container key identifying the data field to visualize in a 3D view.
void gwy_3d_view_set_data_key (Gwy3DView *gwy3dview
,const gchar *key
);
Sets the container key identifying the data field to visualize in a 3D view.
void gwy_3d_view_set_ovlay (Gwy3DView *gwy3dview
,GwyPixmapLayer **ovlays
,guint novlays
);
Sets overlays for a 3D view.
gwy3dview |
A 3D data view widget. |
|
ovlays |
List of |
|
novlays |
Number of items in |
Since: 2.26
const gchar *
gwy_3d_view_get_gradient_key (Gwy3DView *gwy3dview
);
Gets the container key identifying the colour gradient used to visualize data in a 3D view.
void gwy_3d_view_set_gradient_key (Gwy3DView *gwy3dview
,const gchar *key
);
Sets the container key identifying the color gradient to use to visualize data in a 3D view.
const gchar *
gwy_3d_view_get_material_key (Gwy3DView *gwy3dview
);
Gets the key identifying the GL material used to visualize data in a 3D view.
void gwy_3d_view_set_material_key (Gwy3DView *gwy3dview
,const gchar *key
);
Sets the container key of the GL material used to visualize data in a 3D view.
guint
gwy_3d_view_get_reduced_size (Gwy3DView *gwy3dview
);
Returns the reduced data size of a 3D view.
See gwy_3d_view_set_reduced_size()
for details.
void gwy_3d_view_set_reduced_size (Gwy3DView *gwy3dview
,guint reduced_size
);
Sets the reduced data size of a 3D view.
Data larger than reduced size may be shown downsampled during transforms and other changes to speed up the rendering. Final, full-size rendering is then performed after a timeout.
In case of the original data are not square, the reduced_size
is the greater size of the downsampled data, the
other dimension is proportional to the original size.
Changes in reduced size do not cause immediate redraw when an operation is pending and the view is shown in reduced size. It only affects future downsampling.
Note since 2.44 the reduced size has no influence because the 3D view does not downsample anything.
Gwy3DMovement
gwy_3d_view_get_movement_type (Gwy3DView *gwy3dview
);
Returns a movement type describing actual type of response on the mouse motion event.
void gwy_3d_view_set_movement_type (Gwy3DView *gwy3dview
,Gwy3DMovement movement
);
Sets the type of widget response on the mouse motion event.
GdkPixbuf *
gwy_3d_view_get_pixbuf (Gwy3DView *gwy3dview
);
Copies the contents of the 3D view framebuffer to a GdkPixbuf.
The size of the pixbuf is indentical to the size of the widget.
GdkPixbuf *
gwy_3d_view_get_pixbuf_with_alpha (Gwy3DView *gwy3dview
);
Creates a GdkPixbuf from the contents of the 3D view framebuffer, with transparent background.
The size of the pixbuf is indentical to the size of the widget.
The rendered surface is cut perfectly. However, if the scene contains also antialiased labels, these are cut in a way which currently only works with a white background.
Since: 2.54
Gwy3DLabel * gwy_3d_view_get_label (Gwy3DView *gwy3dview
,Gwy3DViewLabel label
);
Gets requested 3D label object of a 3D view.
This is a convenience method that can be used instead of fetching the label object from the data container.
Gwy3DSetup *
gwy_3d_view_get_setup (Gwy3DView *gwy3dview
);
Gets the 3D setup object of a 3D view.
This is a convenience method that can be used instead of fetching the setup object from the data container.
GwyContainer *
gwy_3d_view_get_data (Gwy3DView *gwy3dview
);
Returns the data container this 3D view displays.
void gwy_3d_view_get_scale_range (Gwy3DView *gwy3dview
,gdouble *min_scale
,gdouble *max_scale
);
Obtains the minimum and maximum zoom of a 3D data view
void gwy_3d_view_set_scale_range (Gwy3DView *gwy3dview
,gdouble min_scale
,gdouble max_scale
);
Sets the minimum and maximum zoom of a 3D data view.
Recommended zoom values are 0.5 - 5.0.
void
gwy_3d_view_class_disable_axis_drawing
(gboolean disable
);
Globally disables drawing of 3D view axes.
If axis drawing is disabled, axes are never drawn. If it is not disabled, their rendering depends on the 3D view setup.
This function is a hack and exists to work around various GL implementations that crash on pixmap drawing operations.
Since: 2.14
const gchar *
gwy_3d_view_get_mask_key (Gwy3DView *gwy3dview
);
Gets the container key identifying the mask field for visualisation in a 3D view.
“data-key”
property “data-key” char *
Key identifying data field in container.
Owner: Gwy3DView
Flags: Read / Write
Default value: NULL
“gradient-key”
property “gradient-key” char *
Key identifying color gradient in container.
Owner: Gwy3DView
Flags: Read / Write
Default value: NULL
“mask-key”
property “mask-key” char *
Key identifying mask field in container.
Owner: Gwy3DView
Flags: Read / Write
Default value: NULL
“material-key”
property “material-key” char *
Key identifying GL material in container.
Owner: Gwy3DView
Flags: Read / Write
Default value: NULL
“movement-type”
property“movement-type” Gwy3DMovement
The :movement-type property represents type of action on user pointer drag.
Owner: Gwy3DView
Flags: Read / Write
Default value: GWY_3D_MOVEMENT_NONE
“reduced-size”
property“reduced-size” guint
The :reduced-size is the size of downsampled data in quick preview.
Note since 2.44 the reduced size has no influence because the 3D view does not downsample anything.
Owner: Gwy3DView
Flags: Read / Write
Allowed values: [2,G_MAXINT]
Default value: 96
Gwy3DWindow -- window combining 3D view with controls, GwyGLMaterial -- OpenGL materials, Gwy3DLabel -- Labels on 3D view, Gwy3DSetup -- 3D scene setup