v_sim.DumpScene

Subclasses:

None

Methods

Inherited:

v_sim.Dump (16), v_sim.FileFormat (19), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

	getAlphaStatus ()
	write (fileName, scene, width, height, functionWait, *data)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Inherited:

v_sim.FileFormat (3)

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent	v_sim.Dump	r
priv	v_sim.DumpScenePrivate	r

Class Details

class v_sim.DumpScene(**kwargs)

Bases:

v_sim.Dump

Abstract:

No

Structure:

v_sim.DumpSceneClass

Common name to refer to a #_VisuDumpScene.

getAlphaStatus()

Returns:

True if self has an alpha channel.

Return type:

bool

Retrieve if self use alpha channel or not.

write(fileName, scene, width, height, functionWait, *data)

Parameters:

• fileName (str) – a string that defined the file to write to ;

• scene (v_sim.GlNodeScene) – the v_sim.GlNodeScene to be exported.

• width (int) – an integer ;

• height (int) – an integer ;

• functionWait (v_sim.VoidDataFunc or None) – a method to call periodically during the dump ;

• data (object or None) – some pointer on object to be passed to the wait function.

Raises:

GLib.Error

Returns:

True if dump succeed.

Return type:

bool

Use the write function of self to export the scene to file fileName.

New in version 3.6.