v_sim.ScalarFieldBinaryOp¶

Subclasses:: None

Methods¶

Inherited:: v_sim.ScalarField (19), GObject.Object (37), v_sim.Boxed (2), v_sim.Pointset (9)
Structs:: GObject.ObjectClass (5)

class	`new` (op, a, b)
class	`new_withLeftConst` (op, lValue, b)
class	`new_withRightConst` (op, a, rValue)
	`setLeftField` (field)
	`setRightField` (field)

Virtual Methods¶

Inherited:: v_sim.ScalarField (6), GObject.Object (7), v_sim.Boxed (1), v_sim.Pointset (5)

Properties¶

Inherited:: v_sim.ScalarField (2), v_sim.Boxed (2), v_sim.Pointset (4)

Signals¶

Inherited:: v_sim.ScalarField (1), GObject.Object (1), v_sim.Boxed (2)

Fields¶

Inherited:: v_sim.ScalarField (1), GObject.Object (1), v_sim.Boxed (2)

Name	Type	Access	Description
parent	`v_sim.ScalarField`	r

Class Details¶

class v_sim.ScalarFieldBinaryOp(**kwargs)¶

Bases:: v_sim.ScalarField
Abstract:: No
Structure:: v_sim.ScalarFieldBinaryOpClass

An opaque structure for the scalar field.

classmethod new(op, a, b)¶

Parameters:

op (v_sim.ScalarFieldBinaryOpTypes) – the type of binary operator.
a (v_sim.ScalarField) – a v_sim.ScalarField object.
b (v_sim.ScalarField) – a v_sim.ScalarField object.

Returns:

a newly created v_sim.ScalarFieldBinaryOp object.

Return type:

v_sim.ScalarField

Create a new v_sim.ScalarField object as the operation between scalar field a and b.

New in version 3.8.

classmethod new_withLeftConst(op, lValue, b)¶

Parameters:

op (v_sim.ScalarFieldBinaryOpTypes) – the type of binary operator.
lValue (float) – a constant.
b (v_sim.ScalarField) – a v_sim.ScalarField object.

Returns:

a newly created v_sim.ScalarFieldBinaryOp object.

Return type:

v_sim.ScalarField

Like v_sim.ScalarFieldBinaryOp.new() but with the left member being a constant.

New in version 3.8.

classmethod new_withRightConst(op, a, rValue)¶

Parameters:

op (v_sim.ScalarFieldBinaryOpTypes) – the type of binary operator.
a (v_sim.ScalarField) – a v_sim.ScalarField object.
rValue (float) – a constant.

Returns:

a newly created v_sim.ScalarFieldBinaryOp object.

Return type:

v_sim.ScalarField

Like v_sim.ScalarFieldBinaryOp.new() but with the right member being a constant.

New in version 3.8.

setLeftField(field)¶

Parameters:: field (v_sim.ScalarField) – a v_sim.ScalarField object.
Returns:: True if the left operator is actually changed.
Return type:: bool

Change the left hand side operator to be field.

setRightField(field)¶

Parameters:: field (v_sim.ScalarField) – a v_sim.ScalarField object.
Returns:: True if the right operator is actually changed.
Return type:: bool

Change the right hand side operator to be field.