GfMatrixAttributeModel#

class omni.kit.property.usd.GfMatrixAttributeModel(
stage: Stage,
attribute_paths: List[Path],
comp_count: int,
tf_type: Type,
self_refresh: bool,
metadata: dict,
)#

Bases: MatrixBaseAttributeModel

A model for representing and manipulating GfMatrix attributes in USD.

This model supports various matrix sizes as defined by the composition count and type. It provides functionality to edit individual matrix components and handles their synchronization with the USD attributes.

Parameters:

  • stage (Usd.Stage) – The stage where the USD attributes are defined.

  • attribute_paths (List[Sdf.Path]) – A list of USD attribute paths to be managed by this model.

  • comp_count (int) – The number of components in each row or column of the matrix.

  • tf_type (Tf.Type) – The type of the matrix, typically representing the data precision (e.g., GfMatrix4f for a 4x4 float matrix).

  • self_refresh (bool) – Whether the model should automatically refresh its data when the USD stage changes.

  • metadata (dict) – A dictionary containing metadata for the matrix attributes.

Methods

__init__(stage, attribute_paths, comp_count, ...)

Constructor for GfMatrixAttributeModel.

Attributes

__init__(
stage: Stage,
attribute_paths: List[Path],
comp_count: int,
tf_type: Type,
self_refresh: bool,
metadata: dict,
)#

Constructor for GfMatrixAttributeModel.

Initializes a new instance of GfMatrixAttributeModel.

Parameters:

  • stage (Usd.Stage) – The stage where the USD attributes are defined.

  • attribute_paths (List[Sdf.Path]) – A list of USD attribute paths for which the model is responsible.

  • comp_count (int) – The number of components in each row or column of the matrix.

  • tf_type (Tf.Type) – The type of the matrix, typically representing the data precision (e.g., GfMatrix4f for a 4x4 float matrix).

  • self_refresh (bool) – Whether the model should update itself automatically when changes occur.

  • metadata (dict) – A dictionary containing metadata information for the attribute.