inventor.Field
class Field(object)
Represents a field. Field values can be accessed as attributes of a scene object. Use the field objects to create connections to other fields or engine outputs.Methods defined here:
append_connection(...)
Connects this field as a slave to master while keeping existing connections in place.Args:
-
Field or engine output to connect to.
connect_from(...)
Connects this field as a slave to master.Args:
-
Field or engine output to connect to.
disconnect(...)
Disconnects connections from this field as a slave to master(s).Args:
-
Field or engine output. If none is provided then all connections
will be disconnected.
enable_connection(...)
Enables or disables the connections to this field.Args:
-
True to enable and False to disable connection.
get_connected_engine(...)
Returns engine output that this field is connected to.Returns:
-
Engine output that is connected to this field or None.
get_connected_field(...)
Returns master field that this field is connected to.Returns:
-
Master field that is connected to this field or None.
get_connections(...)
Returns a list of field connections.Returns:
-
List of fields that this fields is a slave of or None.
get_container(...)
Returns the container object of this field.Returns:
-
Instance of field container that the field is part of.
get_enums(...)
Returns the values that an enum or bitmask field understands.Returns:
-
List of strings that are valid values for this field.
get_name(...)
Returns the field name.Returns:
-
String containing the name under which the field is known in
its field container.
get_type(...)
Returns the type of the field.Returns:
-
Inventor field type as string.
is_connected(...)
Returns true if the field is connected to a master.Returns:
-
True if connection from field or engine is active, otherwise False.
is_connection_enabled(...)
Returns if connections to this field is considered active.Returns:
-
True if connection is active, otherwise False.