v_sim.Boxed¶

Implementations:: v_sim.Box, v_sim.Data, v_sim.GlNodeScene, v_sim.GlView, v_sim.Plane, v_sim.PlaneSet, v_sim.ScalarField, v_sim.Surface

Methods¶

	`getBox` ()
	`setBox` (box)

Virtual Methods¶

do_set_box (box)

Properties¶

Name	Type	Flags	Short Description
`auto-adjust`	`bool`	r/w	Adjust internals when box is set
`box`	`v_sim.Box`	r/w	Box

Signals¶

Name	Short Description
`setBox`	Gets emitted when the bounding box is changed.
`unit-changed`	Gets emitted when the units are changed.

Fields¶

None

Class Details¶

class v_sim.Boxed¶

Bases:: GObject.GInterface
Structure:: v_sim.BoxedInterface

Interface for objects with v_sim.Box.

getBox()¶

Returns:: the v_sim.Box of self.
Return type:: v_sim.Box

Retrieves the v_sim.Box of self.

New in version 3.7.

setBox(box)¶

Parameters:: box (v_sim.Boxed) – a v_sim.Boxed object.
Returns:: False boxed was already boxed with the v_sim.Box of box.
Return type:: bool

Attach the v_sim.Box of box to boxed. If update is True, coordinates inside boxed are updated to fit into the new v_sim.Box. A reference is taken on the v_sim.Box of box. This routine emits v_sim.Boxed ::setBox signal if the self has changed its v_sim.Box.

New in version 3.7.

do_set_box(box) virtual¶

Parameters:: box (v_sim.Box) –
Return type:: bool

a routine to set a v_sim.Box to a v_sim.Boxed object.

Signal Details¶

v_sim.Boxed.signals.setBox(boxed, box)¶

Signal Name:

setBox

Flags:

RUN_LAST, NO_RECURSE, NO_HOOKS

Parameters:

boxed (v_sim.Boxed) – The object which received the signal
box (v_sim.Box) – the new box.

Gets emitted when the bounding box is changed.

New in version 3.7.

v_sim.Boxed.signals.unit_changed(boxed, factor)¶

Signal Name:

unit-changed

Flags:

RUN_LAST, NO_RECURSE, NO_HOOKS

Parameters:

boxed (v_sim.Boxed) – The object which received the signal
factor (float) – the factor that has been applied.

Gets emitted when the units are changed.

New in version 3.9.

Property Details¶

v_sim.Boxed.props.auto_adjust¶

Name:: auto-adjust
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Adjust internals when box is set

v_sim.Boxed.props.box¶

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

Box