v_sim.GlExtBox¶

Subclasses:: None

Methods¶

Inherited:: v_sim.GlExt (16), GObject.Object (37), v_sim.GlExtLined (6)
Structs:: GObject.ObjectClass (5)

class	`new` (name)
	`getExpandStipple` ()
	`getSideRGB` ()
	`setBasis` (orig, mat)
	`setBox` (boxObj)
	`setExpandStipple` (stipple)
	`setSideRGB` (rgba, mask)

Virtual Methods¶

Inherited:: v_sim.GlExt (3), GObject.Object (7), v_sim.GlExtLined (6)

Properties¶

Inherited:: v_sim.GlExt (9), v_sim.GlExtLined (3)

Name	Type	Flags	Short Description
`basis`	`v_sim.Box`	r/w	provides the basis-set to draw the box
`expand-stipple`	`int`	r/w	rendering line stipple pattern of extension
`side-color`	`v_sim.Color`	r/w	color of the primary cell sides

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`v_sim.GlExt`	r

Class Details¶

class v_sim.GlExtBox(**kwargs)¶

Bases:: v_sim.GlExt, v_sim.GlExtLined
Abstract:: No
Structure:: v_sim.GlExtBoxClass

An opaque structure.

New in version 3.7.

classmethod new(name)¶

Parameters:: name (str or None) – the name to give to the extension (default is v_sim.GL_EXT_BOX_ID).
Returns:: a pointer to the v_sim.GlExt it created or None otherwise.
Return type:: v_sim.GlExtBox

Creates a new v_sim.GlExt to draw a box.

New in version 3.7.

getExpandStipple()¶

Returns:: the value of current box line pattern.
Return type:: int

Read the line stipple pattern used for box (expanded part).

getSideRGB()¶

Returns:: all the colour values of the current box line.
Return type:: float

Read the colour components of the sides of the box (in [0;1]).

setBasis(orig, mat)¶

Parameters:

orig ([float]) – the origin.
mat ([float]) – the basis-set.

Returns:

True if value is actually changed.

Return type:

bool

Define the box to draw with a simple matrix basis-set and an origin.

New in version 3.7.

setBox(boxObj)¶

Parameters:: boxObj (v_sim.Box) – the box to get the definition of.
Returns:: True if the v_sim.Box model is actually changed.
Return type:: bool

Attach the v_sim.Box to draw the frame of.

New in version 3.7.

setExpandStipple(stipple)¶

Parameters:: stipple (int) – a pattern for line stipple in OpenGL.
Returns:: True if value is actually changed.
Return type:: bool

Method used to change the value of the parameter box_line_stipple (expanded part).

setSideRGB(rgba, mask)¶

Parameters:

rgba ([float]) – a four floats array with values (0 <= values <= 1) for the red, the green, the blue color and the alpha channel. Only values specified by the mask are really relevant.
mask (int) – use v_sim.COLOR_MASK_R, v_sim.COLOR_MASK_G, v_sim.COLOR_MASK_B, v_sim.COLOR_MASK_A or a combinaison to indicate what values in the rgba array must be taken into account.

Returns:

True if value is actually changed.

Return type:

bool

Change the colour to represent the side of the super-cell. A channel alpha of zero, means that the box is rendered as wire-frame only. The sides are indeed drawn only if the box has expansion.

New in version 3.7.

Property Details¶

v_sim.GlExtBox.props.basis¶

Name:: basis
Type:: v_sim.Box
Default Value:: None
Flags:: READABLE, WRITABLE

provides the basis-set to draw the box

v_sim.GlExtBox.props.expand_stipple¶

Name:: expand-stipple
Type:: int
Default Value:: 65280
Flags:: READABLE, WRITABLE

rendering line stipple pattern of extension

v_sim.GlExtBox.props.side_color¶

Name:: side-color
Type:: v_sim.Color
Default Value:: None
Flags:: READABLE, WRITABLE

color of the primary cell sides