v_sim.GlExtSet

g GObject.Object GObject.Object v_sim.Gl v_sim.Gl GObject.Object->v_sim.Gl v_sim.GlExtSet v_sim.GlExtSet v_sim.Gl->v_sim.GlExtSet

Subclasses:

v_sim.GlNodeScene

Methods

Inherited:

v_sim.Gl (42), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new ()

add (ext)

getAll ()

getByName (name)

getPixmapData (width, height, hasAlpha)

initOffscreenContext ()

remove (ext)

setGlView (view)

Virtual Methods

Inherited:

v_sim.Gl (4), GObject.Object (7)

do_added (ext)

do_removed (ext)

Properties

Inherited:

v_sim.Gl (18)

Signals

Inherited:

v_sim.Gl (1), GObject.Object (1)

Fields

Inherited:

v_sim.Gl (1), GObject.Object (1)

Name

Type

Access

Description

parent

v_sim.Gl

r

priv

v_sim.GlExtSetPrivate

r

Class Details

class v_sim.GlExtSet(**kwargs)
Bases:

v_sim.Gl

Abstract:

No

Structure:

v_sim.GlExtSetClass

Common name to refer to a #_VisuGlExtSet.

classmethod new()
Returns:

a newly created v_sim.GlExtSet object.

Return type:

v_sim.GlExtSet

Create an object to handle a set of v_sim.GlExt objects and draw them together.

New in version 3.8.

add(ext)
Parameters:

ext (v_sim.GlExt) – a v_sim.GlExt object.

Returns:

True if not already existing.

Return type:

bool

Add ext in the list of drawn v_sim.GlExt by self.

New in version 3.8.

getAll()
Returns:

only the container list should be freed after.

Return type:

[v_sim.GlExt]

Retrieve as a GLib.List all the v_sim.GlExt objects drawn by self.

New in version 3.8.

getByName(name)
Parameters:

name (str) – a name to look for.

Returns:

a v_sim.GlExt with name.

Return type:

v_sim.GlExt

Retrieve the v_sim.GlExt object with name that is stored in self. If several v_sim.GlExt objects have the same name, the first one is returned.

New in version 3.8.

getPixmapData(width, height, hasAlpha)
Parameters:
  • width (int) – the desired width or 0 for current ;

  • height (int) – the desired height or 0 for current ;

  • hasAlpha (bool) – if True, the returned data is RGBA, else only RGB.

Returns:

image data, row by row.

Return type:

[int]

Create an image from the OpenGL area. The size can be changed, using width and height. If these pointers contains positive values, then they are used to set the size for the image. If not, the size of the current v_sim.GlView is used and stored in these pointers.

New in version 3.8.

initOffscreenContext()
Raises:

GLib.Error

Returns:

True if a context is successfully created.

Return type:

bool

Create an OpenGL context for offscreen rendering. After this call, the context is set current.

New in version 3.9.

remove(ext)
Parameters:

ext (v_sim.GlExt) – a v_sim.GlExt object.

Returns:

True if successfully removed.

Return type:

bool

Remove ext in the list of drawn v_sim.GlExt by self.

New in version 3.8.

setGlView(view)
Parameters:

view (v_sim.GlView) – a v_sim.GlView object.

Returns:

True if the view actually change.

Return type:

bool

Apply the given view on all v_sim.GlExt objects stored in self.

New in version 3.8.

do_added(ext) virtual
Parameters:

ext (v_sim.GlExt) –

executed when ext is added.

do_removed(ext) virtual
Parameters:

ext (v_sim.GlExt) –

executed when ext is removed.