Usage ¶
getAttributeStringArrayData(session
: hapi.Session, node_id
: int
, part_id
: int
, name
: str
, attr_info
: hapi.AttributeInfo, data_fixed_length
: int
, start
: int
, sizes_fixed_length
: int
) → (list
of int
, list
of int
)
Get array attribute string data. Each entry in an array attribute can have varying array lengths. Therefore the array values are returned as a flat array, with another sizes array containing the lengths of each array entry. Note that the string handles returned are only valid until the next time this function is called.
session
The session of Houdini you are interacting with. See hapi.Session for more on sessions. Pass None to just use the default in-process session.
node_id
The node id.
part_id
The part id.
name
Attribute name.
attr_info
hapi.AttributeInfo used as input for the. totalArrayElements. Also contains some sanity checks like data type. Generally should be the same struct returned by hapi.getAttributeInfo.
data_fixed_length
start
First index of range. Must be at least 0 and at most hapi.AttributeInfo.count - 1.
sizes_fixed_length
Must be at least 0 and at most
hapi.AttributeInfo.count - start
.
Note, if 0 is passed for length, the function will just
do nothing and return hapi.result.Success.
The string handles should be used to retrieve the strings immediately and are invalidated when another call to get this attribute’s data is made.
Returns a tuple of (data_fixed_array, sizes_fixed_array).