Gwyddion – Free SPM (AFM, SNOM/NSOM, STM, MFM, …) data analysis software

Gwy3DSetup

Gwy3DSetup — 3D scene setup

Functions

Gwy3DSetup * gwy_3d_setup_new ()

Properties

gboolean axes-visible Read / Write
gboolean fmscale-reserve-space Read / Write
gdouble fmscale-size Read / Write
gboolean fmscale-visible Read / Write
gdouble fmscale-y-align Read / Write
gboolean hide-masked Read / Write
gboolean labels-visible Read / Write
gdouble light-phi Read / Write
gdouble light-theta Read / Write
gdouble line-width Read / Write
Gwy3DProjection projection Read / Write
gdouble rotation-x Read / Write
gdouble rotation-y Read / Write
gdouble scale Read / Write
Gwy3DVisualization visualization Read / Write
gdouble z-scale Read / Write

Types and Values

struct Gwy3DSetup
struct Gwy3DSetupClass

Object Hierarchy

    GObject
    ╰── Gwy3DSetup

Implemented Interfaces

Gwy3DSetup implements GwySerializable.

Includes

#include <libgwydgets/gwydgets.h>

Description

Gwy3DSetup represents a basic 3D scene setup: viewpoint, projection, light, scale, etc. It is serializable and used to represent the Gwy3DView setup.

Its components can be read directly in the struct or generically with g_object_get(). To set them you it is necessary to use g_object_set().

Functions

gwy_3d_setup_new ()

Gwy3DSetup *
gwy_3d_setup_new (void);

Creates a new 3D view setup with default values.

Returns

A newly created 3D view setup.

Types and Values

struct Gwy3DSetup

struct Gwy3DSetup;

struct Gwy3DSetupClass

struct Gwy3DSetupClass {
    GObjectClass parent_class;

    void (*reserved1)(void);
    void (*reserved2)(void);
};

Property Details

The “axes-visible” property

  “axes-visible”             gboolean

Whether axes are visible.

Flags: Read / Write

Default value: TRUE

The “fmscale-reserve-space” property

  “fmscale-reserve-space”    gboolean

Whethere to reserve entire vertical stripe of the false colour scale.

Flags: Read / Write

Default value: TRUE

Since: 2.49

The “fmscale-size” property

  “fmscale-size”             gdouble

Size of false colour scale relative to view height.

Flags: Read / Write

Allowed values: [0,1]

Default value: 1

Since: 2.49

The “fmscale-visible” property

  “fmscale-visible”          gboolean

Whether false color bar is visible.

Flags: Read / Write

Default value: FALSE

The “fmscale-y-align” property

  “fmscale-y-align”          gdouble

Vertical alignment of false colour scale.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0.5

Since: 2.49

The “hide-masked” property

  “hide-masked”              gboolean

Hide masked vertices.

Flags: Read / Write

Default value: FALSE

The “labels-visible” property

  “labels-visible”           gboolean

Whether axis labels are visible if axes are visible.

Flags: Read / Write

Default value: TRUE

The “light-phi” property

  “light-phi”                gdouble

Light source direction azimuth in horizontal plane, in radians.

Flags: Read / Write

Default value: 0

The “light-theta” property

  “light-theta”              gdouble

Light source direction deviation from the z axis, in radians.

Flags: Read / Write

Default value: 0

The “line-width” property

  “line-width”               gdouble

Width of axis lines and ticks, in pixels.

Flags: Read / Write

Allowed values: [1,10]

Default value: 1

Since: 2.42

The “projection” property

  “projection”               Gwy3DProjection

The type of the projection.

Flags: Read / Write

Default value: GWY_3D_PROJECTION_ORTHOGRAPHIC

The “rotation-x” property

  “rotation-x”               gdouble

Angle of the first rotation around x-axis, in radians.

Flags: Read / Write

Default value: 0.785398

The “rotation-y” property

  “rotation-y”               gdouble

Angle of the second rotation around y-axis, in radians.

Flags: Read / Write

Default value: -0.785398

The “scale” property

  “scale”                    gdouble

Overall view scale.

Flags: Read / Write

Allowed values: >= G_MINDOUBLE

Default value: 1

The “visualization” property

  “visualization”            Gwy3DVisualization

Data visualization type.

Flags: Read / Write

Default value: GWY_3D_VISUALIZATION_GRADIENT

The “z-scale” property

  “z-scale”                  gdouble

Extra stretch along z (value) axis.

Flags: Read / Write

Allowed values: >= G_MINDOUBLE

Default value: 1

See Also

Gwy3DView -- the basic 3D data display widget

© David Nečas and Petr Klapetek

Home Download News Features Screenshots Documentation Communicate Participate Resources Publications Applications Site Map

Valid XHTML 1.0 Valid CSS