## On this page

  

 

 # FieldDefinition

 Last update: 16.07.2026 

<a id="compolyx.FieldDefinition"></a>

### *class* compolyx.FieldDefinition(graph, obj, parent=None)

Represents a field definition.

### Attributes

NameDescription[`FieldDefinition.active`](compolyx.FieldDefinition.active.md#compolyx.FieldDefinition.active)Indicates whether the field definition is active.[`FieldDefinition.enabled`](compolyx.FieldDefinition.enabled.md#compolyx.FieldDefinition.enabled)Indicates whether the object is enabled.[`FieldDefinition.field_variable_name`](compolyx.FieldDefinition.field_variable_name.md#compolyx.FieldDefinition.field_variable_name)Name of the field variable.[`FieldDefinition.full_mapping`](compolyx.FieldDefinition.full_mapping.md#compolyx.FieldDefinition.full_mapping)Whether the field is interpolated to the shell reference surface or to the actual ply-position by taking into account the shell offset; in solid models the interpolation takes always place at the actual ply position.[`FieldDefinition.id`](compolyx.FieldDefinition.id.md#compolyx.FieldDefinition.id)ID of the object.[`FieldDefinition.is_dict_item`](compolyx.FieldDefinition.is_dict_item.md#compolyx.FieldDefinition.is_dict_item)Indicates whether the object is an item in a dictionary.[`FieldDefinition.is_list_item`](compolyx.FieldDefinition.is_list_item.md#compolyx.FieldDefinition.is_list_item)Indicates whether the object is an item of a list.[`FieldDefinition.link_path`](compolyx.FieldDefinition.link_path.md#compolyx.FieldDefinition.link_path)Root path of the current node in the tree for links to this object.[`FieldDefinition.locked`](compolyx.FieldDefinition.locked.md#compolyx.FieldDefinition.locked)Returns the locked status of the Field Definition.[`FieldDefinition.name`](compolyx.FieldDefinition.name.md#compolyx.FieldDefinition.name)Name of the object.[`FieldDefinition.parent`](compolyx.FieldDefinition.parent.md#compolyx.FieldDefinition.parent)Parent object in the tree.[`FieldDefinition.root_path`](compolyx.FieldDefinition.root_path.md#compolyx.FieldDefinition.root_path)Root path of the current node in the tree.[`FieldDefinition.scalar_field`](compolyx.FieldDefinition.scalar_field.md#compolyx.FieldDefinition.scalar_field)Lookup‑table column used with this field definition.[`FieldDefinition.scope_entities`](compolyx.FieldDefinition.scope_entities.md#compolyx.FieldDefinition.scope_entities)The entities defining the scope of the field definition.[`FieldDefinition.status`](compolyx.FieldDefinition.status.md#compolyx.FieldDefinition.status)Status of the object.[`FieldDefinition.status_changed`](compolyx.FieldDefinition.status_changed.md#compolyx.FieldDefinition.status_changed)Boolean flag which is set to true in C++ when up-to-date status of object changes.[`FieldDefinition.uid`](compolyx.FieldDefinition.uid.md#compolyx.FieldDefinition.uid)UID of the object.[`FieldDefinition.vertex`](compolyx.FieldDefinition.vertex.md#compolyx.FieldDefinition.vertex)Raises an error if the object has been removed from the graph.### Methods

NameDescription[`FieldDefinition.clear_field_definition`](compolyx.FieldDefinition.clear_field_definition.md#compolyx.FieldDefinition.clear_field_definition)()[`FieldDefinition.clear_scope_entities`](compolyx.FieldDefinition.clear_scope_entities.md#compolyx.FieldDefinition.clear_scope_entities)()[`FieldDefinition.find_parent`](compolyx.FieldDefinition.find_parent.md#compolyx.FieldDefinition.find_parent)(type)Steps up the tree and returns the first parent with given type.[`FieldDefinition.get_short_description`](compolyx.FieldDefinition.get_short_description.md#compolyx.FieldDefinition.get_short_description)()[`FieldDefinition.obj_exists`](compolyx.FieldDefinition.obj_exists.md#compolyx.FieldDefinition.obj_exists)()Checks if \_\_obj still references the c++ object (has not been reset to None by self.\_delete) and exists in the graph.[`FieldDefinition.serialize`](compolyx.FieldDefinition.serialize.md#compolyx.FieldDefinition.serialize)()Serialize to Python string.[`FieldDefinition.serialize_name_and_id`](compolyx.FieldDefinition.serialize_name_and_id.md#compolyx.FieldDefinition.serialize_name_and_id)()Serializes the name and ID.[`FieldDefinition.update`](compolyx.FieldDefinition.update.md#compolyx.FieldDefinition.update)()[`FieldDefinition.visit`](compolyx.FieldDefinition.visit.md#compolyx.FieldDefinition.visit)(visitor)Walk through the tree and let the visitor perform action on every descendant node.