API reference - Class PCellParameterState

ErrorIcon

Signature: [static,const] PCellParameterState::ParameterStateIcon ErrorIcon

Description: An icon indicating an error is shown

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

InfoIcon

Signature: [static,const] PCellParameterState::ParameterStateIcon InfoIcon

Description: A general 'information' icon is shown

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

NoIcon

Signature: [static,const] PCellParameterState::ParameterStateIcon NoIcon

Description: No icon is shown for the parameter

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

WarningIcon

Signature: [static,const] PCellParameterState::ParameterStateIcon WarningIcon

Description: An icon indicating a warning is shown

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

_const_cast

Signature: [const] PCellParameterState 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.

assign

Signature: void assign (const PCellParameterState other)

Description: Assigns another object to self

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.

dup

Signature: [const] new PCellParameterState ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

enabled=

Signature: void enabled= (bool f)

Description: Sets a value indicating whether the parameter is enabled in the parameter form

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

icon

Signature: [const] PCellParameterState::ParameterStateIcon icon

Description: Gets the icon for the parameter

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

icon=

Signature: void icon= (PCellParameterState::ParameterStateIcon i)

Description: Sets the icon for the parameter

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

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_enabled?

Signature: [const] bool is_enabled?

Description: Gets a value indicating whether the parameter is enabled in the parameter form

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

is_readonly?

Signature: [const] bool is_readonly?

Description: Gets a value indicating whether the parameter is read-only (not editable) in the parameter form

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

is_visible?

Signature: [const] bool is_visible?

Description: Gets a value indicating whether the parameter is visible in the parameter form

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

new

Signature: [static] new PCellParameterState ptr new

Description: Creates a new object of this class

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

readonly=

Signature: void readonly= (bool f)

Description: Sets a value indicating whether the parameter is made read-only (not editable) in the parameter form

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

tooltip

Signature: [const] string tooltip

Description: Gets the tool tip text

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

tooltip=

Signature: void tooltip= (string s)

Description: Sets the tool tip text

The tool tip is shown when hovering over the parameter label or edit field.

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

value

Signature: [const] variant value

Description: Gets the value of the parameter

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

value=

Signature: void value= (variant v)

Description: Sets the value of the parameter

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

visible=

Signature: void visible= (bool f)

Description: Sets a value indicating whether the parameter is visible in the parameter form

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