v_sim.GlExtSurfaces¶

Subclasses:: None

Methods¶

Inherited:: v_sim.GlExt (60), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (name)
	`add` (surf)
	`getDrawIntra` ()
	`remove` (surf)
	`removeAll` ()
	`setDrawIntra` (status)
	`setFittingBox` (box)
	`setMask` (mask)
	`setOnObserveOrdering` (inter)

Virtual Methods¶

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

Properties¶

Inherited:: v_sim.GlExt (11)

Name	Type	Flags	Short Description
`draw-intra`	`bool`	r/w	use inverse colour for inside
`fitting-box`	`v_sim.Box`	r/w	If set, all surfaces are scaled to fit this box.

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`added`	This signal is emitted each time a surface is added to the set.
`removed`	This signal is emitted each time a surface is removed from the set.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`v_sim.GlExt`	r
priv	`v_sim.GlExtSurfacesPrivate`	r

Class Details¶

class v_sim.GlExtSurfaces(**kwargs)¶

Bases:: v_sim.GlExt
Abstract:: No
Structure:: v_sim.GlExtSurfacesClass

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_SURFACES_ID).
Returns:: a pointer to the v_sim.GlExt it created or None otherwise.
Return type:: v_sim.GlExtSurfaces

Creates a new v_sim.GlExt to draw surfaces.

New in version 3.7.

add(surf)¶

Parameters:: surf (v_sim.Surface) – a v_sim.Surface object.
Returns:: False if surf was already registered.
Return type:: bool

Add a new surface to the list of drawn surfaces.

New in version 3.7.

getDrawIntra()¶

Returns:: True if the interior is painted in colour inverse.
Return type:: bool

Retrieve if the interiors of surfaces are drawn with a colour inverse or not.

remove(surf)¶

Parameters:: surf (v_sim.Surface) – a v_sim.Surface object.
Returns:: True if surf was part of the drawn surfaces.
Return type:: bool

Removes surf from the list of drawn surfaces.

New in version 3.7.

removeAll()¶: Removes all surfaces from the list of drawn surfaces.

New in version 3.9.

setDrawIntra(status)¶

Parameters:: status (bool) – a boolean.
Returns:: True if the status actually changed.
Return type:: bool

Set if the interiors of surfaces are drawn with a colour inverse or not.

setFittingBox(box)¶

Parameters:: box (v_sim.Box or None) – a v_sim.Box object.
Returns:: True if value is actually changed.
Return type:: bool

Changes the box from which surfaces are scaled in.

New in version 3.8.

setMask(mask)¶

Parameters:: mask (v_sim.PlaneSet or None) – a v_sim.PlaneSet object.
Returns:: True if mask is changed.
Return type:: bool

Attach mask to every surface of the set.

New in version 3.8.

setOnObserveOrdering(inter)¶

Parameters:: inter (v_sim.Interactive or None) – a v_sim.Interactive object.
Returns:: True if the status actually changed.
Return type:: bool

Attach self to inter, so it can be rendered there.

New in version 3.7.

Signal Details¶

v_sim.GlExtSurfaces.signals.added(gl_ext_surfaces, surface)¶

Signal Name:

added

Flags:

RUN_LAST, NO_RECURSE, NO_HOOKS

Parameters:

gl_ext_surfaces (v_sim.GlExtSurfaces) – The object which received the signal
surface (v_sim.Surface) – the added v_sim.Surface object.

This signal is emitted each time a surface is added to the set.

New in version 3.8.

v_sim.GlExtSurfaces.signals.removed(gl_ext_surfaces, surface)¶

Signal Name:

removed

Flags:

RUN_LAST, NO_RECURSE, NO_HOOKS

Parameters:

gl_ext_surfaces (v_sim.GlExtSurfaces) – The object which received the signal
surface (v_sim.Surface) – the removed v_sim.Surface object.

This signal is emitted each time a surface is removed from the set.

New in version 3.8.

Property Details¶

v_sim.GlExtSurfaces.props.draw_intra¶

Name:: draw-intra
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

use inverse colour for inside

v_sim.GlExtSurfaces.props.fitting_box¶

Name:: fitting-box
Type:: v_sim.Box
Default Value:: None
Flags:: READABLE, WRITABLE

If set, all surfaces are scaled to fit this box.