hou.DopData class

Return a dictionary mapping names to DOP data instances for the subdata attached to this data.

# The following code assumes you have created a box from the shelf and used
# Rigid Bodies > RBD Object on the shelf to make it a rigid body.
>>> obj = hou.node("/obj/AutoDopNetwork").simulation().objects()[0]
>>> obj
<hou.DopObject box_object1 id 0>
>>> obj.recordTypes()
('Basic', 'Options', 'RelInGroup', 'RelInAffectors')
>>> record = obj.record("Options")
>>> record.fieldNames()
('name', 'groups', 'affectors', 'affectorids', 'objid')
>>> record.field("name")
'box_object1'

>>> obj.subData().keys()
['PhysicalParms', 'ODE_Body', 'Solver', 'Geometry', 'SolverParms', 'ODE_Geometry', 'Forces', 'Position', 'Colliders']
>>> obj.findSubData("Forces/Gravity_gravity1")
<hou.DopData of type SIM_ForceGravity>
>>> obj.findSubData("Forces/Gravity_gravity1").options().field("force")
<hou.Vector3 [0, -9.80665, 0]>

Return the DOP data with the given name that is attached to this DOP data, or None if no such data exists. Note that the name may also be a slash-separated path to nested subdata.

See hou.DopData.subData for an example.

This method can be approximately implemented as follows:

def findSubData(self, data_spec):
    data = self
    for name in data_spec.split("/"):
        if name not in data.subData():
            return None
        data = data.subData()[name]
    return data

Given a pattern, return a dictionary mapping subdata paths to DOP data instances for all the subdatas whose name matches the pattern. If recurse is True, all grandchildren subdata will be added to the result.

# The following code assumes you have created a box from the shelf and used
# Rigid Bodies > RBD Object on the shelf to make it a rigid body.
>>> obj = hou.node("/obj/AutoDopNetwork").simulation().objects()[0]
>>> obj.findAllSubData("S*").keys()
['SolverParms', 'Solver']
>>> obj.findAllSubData("S*", recurse=True).keys()
['SolverParms', 'Solver/Random', 'SolverParms/ActiveValue', 'Solver']
>>> obj.findAllSubData("S*/*", recurse=True).keys()
['SolverParms/ActiveValue', 'Solver/Random']

Return a string describing the type of data this object contains.

>>> obj = hou.node("/obj/AutoDopNetwork").simulation().objects()[0]
>>> obj.dataType()
'SIM_Object'

See also hou.DopData.dataTypeObject.

Not implemented yet

Return the hou.DopDataType object corresponding to this object’s data type, or None if there is no corresponding hou.DopDataType instance. Most type names do have a corresponding type object.

This method can be approximately implemented as follows:

def dataTypeObject(self):
    return hou.dop.findDataType(self.dataType())

See also hou.DopData.dataType.

Return a tuple of strings containing the record types stored inside this DOP data. Each DOP data contains records named “Basic” and “Options”, and some types of DOP data contain additional records.

Given a record type name return that record, or None if no record exists with that name. If this DOP data contains multiple records with this record type name you can think of each record as a row in a spreadsheet, and record_index determines which one is returned. Use len(self.records(record_type)) to determine how many records of this type are in this DOP data.

Use hou.DopData.recordTypes to get a tuple of record types in a DOP data. See also hou.DopData.records for an example, and see hou.DopData.options for a way to easily access the “Options” record.

Return a tuple of all the records of this record type. See also hou.DopData.record.

This example lists the input affectors for a rigid body box that collides with a ground plane:

>>> obj = hou.node("/obj/AutoDopNetwork").simulation().objects()[-1]
>>> obj.records("RelInAffectors")
(<hou.DopRecord of type RelInAffectors index 0>, <hou.DopRecord of type RelInAffectors index 1>)
>>> [record.field("relname") for record in obj.records("RelInAffectors")]
['merge1', 'staticsolver1_staticsolver1']
>>> obj.record("RelInAffectors", 1).field("relname")
'staticsolver1_staticsolver1'

Return the Options record. This method is a shortcut for self.record("Options").

Return the DOP network node containing this DOP data.

Return the DOP simulation containing this DOP data. This method is a shortcut for self.dopNetNode().simulation().

Return the DOP node that created this DOP data inside the DOP network.

Return the globally unique identifier (GUID) for this DOP data. This method is a shortcut for self.record("Basic").field("uniqueid").

If you want an object’s index, hou.DopObject.objid.

>>> obj = hou.node("/obj/AutoDopNetwork").simulation().objects()[0]
>>> obj.id()
'0xD011E41C-0x000034AE-0x494C12E4-0x000018B9'
>>> obj.objid()
0

Not implemented yet

Save this DOP data to a file. You can load in this data using a File Data DOP.

You might use this method to cache data that takes a long time to generate and is only generated once at the start of a simulation, such as the volume representation of an object for collision detection. You would then modify your DOP network to use a File Data DOP to read in that data instead of computing it.

Raises hou.OperationFailed if the file could not be created.

Create subdata under this data with the specified name and type. You would call this method from a script solver DOP.

Raises hou.OperationFailed if data with this name already exists. If you want to replace existing data it is up to you to first call hou.DopData.removeData.

Raises hou.PermissionError if called from outside a script solver DOP.

Use hou.DopData.attachSubData to create a reference to existing data. See hou.DopData.copyContentsFrom for an example of how to create a copy of existing data.

Make existing data become subdata of this data. Houdini does not create a duplicate of the data. Instead, the data’s parent(s) and this data will both refer to the same instance of subdata. You would call this method from a script solver DOP.

Raises hou.OperationFailed if data with this name already exists. If you want to replace existing data it is up to you to first call hou.DopData.removeData.

Raises hou.PermissionError if called from outside a script solver DOP.

See hou.DopData.copyContentsFrom for an example of how to create a copy of existing data.

Remove subdata with the given name. Raises hou.PermissionError if called from outside a script solver DOP.

Raises hou.OperationFailed if data with that name already exists.

Copy the contents of the given DopData into this one, adapting the data if it is of a different type. You would call this method from a script solver DOP.

Raises hou.PermissionError if called from outside a script solver DOP.

Use this method along with hou.DopData.createSubData to copy existing subdata:

def copySubData(new_parent_data, data_to_copy, new_data_name, avoid_name_collisions=False):
    '''Create a copy of data and attach it to other data.'''
    new_data = new_parent_data.createSubData(new_data_name, data_to_copy.dataType(), avoid_name_collisions)
    new_data.copyContentsFrom(data_to_copy)
    return new_data