VisuPointset

VisuPointset — Defines a common interface for objects with points inside a box that can be translated or expanded.

Functions

Properties

gboolean in-the-box Read / Write
ToolVector * reduced-translation Read / Write
ToolVector * translation Read / Write
gboolean use-translation Read / Write

Types and Values

Object Hierarchy

    GInterface
    ╰── VisuPointset

Prerequisites

VisuPointset requires VisuBoxed and GObject.

Known Implementations

VisuPointset is implemented by VisuData, VisuDataAtomic, VisuDataSpin, VisuScalarField, VisuScalarFieldBinaryOp and VisuScalarFieldData.

Description

Functions

visu_pointset_setInTheBox ()

gboolean
visu_pointset_setInTheBox (VisuPointset *self,
                           gboolean status);

Update all node positions inside self to be constrained inside the box (status is TRUE), or release all previous position shift to original position without constrain (status is FALSE).

Parameters

self

a VisuPointset object.

 

status

a boolean.

 

Returns

TRUE, if any node has changed position.

Since: 3.8


visu_pointset_setTranslationActive ()

gboolean
visu_pointset_setTranslationActive (VisuPointset *self,
                                    gboolean status);

Set the if the translations are applied or not to self .

Parameters

self

a VisuPointset object.

 

status

a boolean.

 

Returns

TRUE if status is changed.

Since: 3.8


visu_pointset_applyTranslation ()

void
visu_pointset_applyTranslation (VisuPointset *self);

Apply all the translation (node and box) on each node coordinates and reset both translations to zero.

Parameters

self

a VisuPointset object.

 

Since: 3.8


visu_pointset_getTranslation ()

void
visu_pointset_getTranslation (VisuPointset *self,
                              float trans[3]);

Retrieves the translations of self .

Parameters

self

a VisuPointset object.

 

trans

a location to store the translation values.

[array fixed-size=3][out]

Since: 3.8


visu_pointset_setTranslation ()

gboolean
visu_pointset_setTranslation (VisuPointset *self,
                              float trans[3],
                              gboolean withModulo);

Apply the given translation values to self . If withModulo is given, all points inside the pointset will be shifted inside the periodic cell.

Parameters

self

a VisuPointset object.

 

trans

the translations.

[array fixed-size=3]

withModulo

a boolean.

 

Returns

FALSE pointset was already pointset with the VisuBox of box .

Since: 3.8


visu_pointset_setTranslationPeriodic ()

gboolean
visu_pointset_setTranslationPeriodic (VisuPointset *self,
                                      float trans[3],
                                      gboolean withModulo);

This sets the translations of the specified VisuPointset only in periodic boundary conditions. Points are also constrainted inside the box in the periodic directions if withModulo is TRUE.

Parameters

self

a VisuPointset object ;

 

trans

an array of floating point values.

[in][array fixed-size=3]

withModulo

a boolean.

 

Returns

TRUE if any translations have been changed.


visu_pointset_setBoxTranslation ()

gboolean
visu_pointset_setBoxTranslation (VisuPointset *self,
                                 float boxTrans[3],
                                 gboolean withModulo);

This sets the translations of the specified VisuPointset only along periodic axis. The translation boxTrans gives normalized values along all box axis. Points are also constrainted inside the box in the periodic directions if withModulo is TRUE.

Parameters

self

a VisuPointset object ;

 

boxTrans

an array of floating point values.

[in][array fixed-size=3]

withModulo

a boolean.

 

Returns

TRUE if any translations have been changed.

Since: 3.8


visu_pointset_getTranslationPeriodicStatus ()

gboolean
visu_pointset_getTranslationPeriodicStatus
                               (VisuPointset *self);

Tests if any of the translation in the periodic boundary conditions are not null.

Parameters

self

a VisuPointset object.

 

Returns

TRUE if any of the translation in the periodic boundary conditions are not null.

Since: 3.8

Types and Values

struct VisuPointsetInterface

struct VisuPointsetInterface {
  VisuBoxedInterface parent;

  gboolean (*set_inTheBox) (VisuPointset *self, gboolean status);

  gboolean (*set_translationActive) (VisuPointset *self, gboolean status);
  void (*get_translation) (VisuPointset *self, float translation[3]);
  gboolean (*set_translation) (VisuPointset *self, float translation[3], gboolean withModulo);

  void (*apply_translation) (VisuPointset *set);
};

The different routines common to objects implementing a VisuPointset interface.

Members

VisuBoxedInterface parent;

yet, its parent.

 

set_inTheBox ()

a routine to translate every content in the box.

 

set_translationActive ()

a routine to activate or not the translation.

 

get_translation ()

a routine to get the current translation status.

 

set_translation ()

a routine to set the translation status.

 

apply_translation ()

a routine to apply the stored translations.

 

Since: 3.8


VisuPointset

typedef struct _VisuPointset VisuPointset;

Interface object.

Since: 3.8

Property Details

The “in-the-box” property

  “in-the-box”               gboolean

All nodes are constrained in the box.

Flags: Read / Write

Default value: FALSE


The “reduced-translation” property

  “reduced-translation”      ToolVector *

Translations along box axis.

Flags: Read / Write


The “translation” property

  “translation”              ToolVector *

Translations along all axis.

Flags: Read / Write


The “use-translation” property

  “use-translation”          gboolean

Use translations along all axis.

Flags: Read / Write

Default value: FALSE

See Also

VisuData, VisuSurface, VisuScalarField