API reference - Class TextPropertiesExpressions

_const_cast

Signature: [const] TextPropertiesExpressions ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

is_isotropic

Signature: void is_isotropic

Description: Indicates that the filter has isotropic properties

Call this method before using the filter to indicate that the selection is independent of the orientation of the shape. This helps the filter algorithm optimizing the filter run, specifically in hierarchical mode.

Examples for isotropic (polygon) processors are size or shrink operators. Size or shrink is not dependent on orientation unless size or shrink needs to be different in x and y direction.

is_isotropic_and_scale_invariant

Signature: void is_isotropic_and_scale_invariant

Description: Indicates that the filter is isotropic and scale invariant

Call this method before using the filter to indicate that the selection is independent of the scale and orientation of the shape. This helps the filter algorithm optimizing the filter run, specifically in hierarchical mode.

An example for such a (polygon) processor is the convex decomposition operator. The decomposition of a polygon into convex parts is an operation that is not depending on scale nor orientation.

is_scale_invariant

Signature: void is_scale_invariant

Description: Indicates that the filter is scale invariant

Call this method before using the filter to indicate that the selection is independent of the scale of the shape. This helps the filter algorithm optimizing the filter run, specifically in hierarchical mode.

An example for a scale invariant (polygon) processor is the rotation operator. Rotation is not depending on scale, but on the original orientation as mirrored versions need to be rotated differently.

new

(1) Signature: [static] new TextPropertiesExpressions ptr new (const Texts ptr texts, map<variant,string> expressions, bool copy_properties = false, map<string,variant> variables = {}, double dbu = 0)

Description: Creates a new properties expressions operator

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new TextPropertiesExpressions ptr new (const Texts ptr texts, string expression, bool copy_properties = false, map<string,variant> variables = {}, double dbu = 0)

Description: Creates a new properties expressions operator

Python specific notes:
This method is the default initializer of the object.

requires_raw_input=

Signature: void requires_raw_input= (bool flag)

Description: Sets a value indicating whether the processor needs raw (unmerged) input

This flag must be set before using this processor. It tells the processor implementation whether the processor wants to have raw input (unmerged). The default value is 'false', meaning that the processor will receive merged polygons ('merged semantics').

Setting this value to false potentially saves some CPU time needed for merging the polygons. Also, raw input means that strange shapes such as dot-like edges, self-overlapping polygons, empty or degenerated polygons are preserved.

Python specific notes:
The object exposes a writable attribute 'requires_raw_input'. This is the setter.

requires_raw_input?

Signature: [const] bool requires_raw_input?

Description: Gets a value indicating whether the processor needs raw (unmerged) input

See requires_raw_input= for details.

Python specific notes:
The object exposes a readable attribute 'requires_raw_input'. This is the getter.

result_is_merged=

Signature: void result_is_merged= (bool flag)

Description: Sets a value indicating whether the processor delivers merged output

This flag must be set before using this processor. If the processor maintains the merged condition by design (output is merged if input is), it is a good idea to set this predicate to 'true'. This will avoid additional merge steps when the resulting collection is used in further operations that need merged input .

Python specific notes:
The object exposes a writable attribute 'result_is_merged'. This is the setter.

result_is_merged?

Signature: [const] bool result_is_merged?

Description: Gets a value indicating whether the processor delivers merged output

See result_is_merged= for details.

Python specific notes:
The object exposes a readable attribute 'result_is_merged'. This is the getter.

result_must_not_be_merged=

Signature: void result_must_not_be_merged= (bool flag)

Description: Sets a value indicating whether the processor's output must not be merged

This flag must be set before using this processor. The processor can set this flag if it wants to deliver shapes that must not be merged - e.g. point-like edges or strange or degenerated polygons. .

Python specific notes:
The object exposes a writable attribute 'result_must_not_be_merged'. This is the setter.

result_must_not_be_merged?

Signature: [const] bool result_must_not_be_merged?

Description: Gets a value indicating whether the processor's output must not be merged

See result_must_not_be_merged= for details.

Python specific notes:
The object exposes a readable attribute 'result_must_not_be_merged'. This is the getter.

wants_variants=

Signature: void wants_variants= (bool flag)

Description: Sets a value indicating whether the filter prefers cell variants

This flag must be set before using this filter for hierarchical applications (deep mode). It tells the filter implementation whether cell variants should be created (true, the default) or shape propagation will be applied (false).

This decision needs to be made, if the filter indicates that it will deliver different results for scaled or rotated versions of the shape (see is_isotropic and the other hints). If a cell is present with different qualities - as seen from the top cell - the respective instances need to be differentiated. Cell variant formation is one way, shape propagation the other way. Typically, cell variant formation is less expensive, but the hierarchy will be modified.

Python specific notes:
The object exposes a writable attribute 'wants_variants'. This is the setter.

wants_variants?

Signature: [const] bool wants_variants?

Description: Gets a value indicating whether the filter prefers cell variants

See wants_variants= for details.

Python specific notes:
The object exposes a readable attribute 'wants_variants'. This is the getter.