### OFloatGeomParamSample Methods Source: https://docs.alembic.io/python/abcg Methods for managing OFloatGeomParamSample, including getting and setting indices, scope, and values. ```APIDOC ## OFloatGeomParamSample Methods ### Description Provides methods for interacting with `OFloatGeomParamSample`, including retrieving indices, scope, and values, as well as resetting and setting these properties. ### Method Not applicable (methods of a class instance) ### Endpoint Not applicable (methods of a class instance) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body Parameters vary depending on the specific method: * **arg1** (OFloatGeomParamSample) - Required - The `OFloatGeomParamSample` instance. * **arg2** (object) - Required - Data to set for indices or values. * **scope** (GeometryScope) - Required - The geometry scope to set. ### Request Example None ### Response #### Success Response Responses vary by method: * **getIndices**: Returns `object`. * **getScope**: Returns `GeometryScope`. * **getVals**: Returns `object`. * **reset**: Returns `None`. * **setIndices**: Returns `None`. * **setScope**: Returns `None`. * **setVals**: Returns `None`. * **valid**: Returns `bool`. #### Response Example For `valid` method: ```json { "example": true } ``` For `getVals` method: ```json { "example": [1.0, 2.0, 3.0] } ``` ``` -------------------------------- ### OQuatdGeomParamSample Methods (Python) Source: https://docs.alembic.io/python/abcg Enables interaction with sample data for OQuatdGeomParam. It allows getting indices, scope, and values, as well as resetting and setting these properties. It also supports setting the scope for the sample. ```python getIndices(arg1: OQuatdGeomParamSample) -> object getScope(arg1: OQuatdGeomParamSample) -> GeometryScope getVals(arg1: OQuatdGeomParamSample) -> object reset(arg1: OQuatdGeomParamSample) -> None setIndices(arg1: OQuatdGeomParamSample, arg2: object) -> None setScope(arg1: OQuatdGeomParamSample, scope: GeometryScope) -> None setVals(arg1: OQuatdGeomParamSample, arg2: object) -> None valid(arg1: OQuatdGeomParamSample) -> bool ``` -------------------------------- ### OQuatfGeomParamSample Methods (Python) Source: https://docs.alembic.io/python/abcg Enables interaction with sample data for OQuatfGeomParam. It allows getting indices, scope, and values, as well as resetting and setting these properties. It also supports setting the scope for the sample. ```python getIndices(arg1: OQuatfGeomParamSample) -> object getScope(arg1: OQuatfGeomParamSample) -> GeometryScope getVals(arg1: OQuatfGeomParamSample) -> object reset(arg1: OQuatfGeomParamSample) -> None setIndices(arg1: OQuatfGeomParamSample, arg2: object) -> None setScope(arg1: OQuatfGeomParamSample, scope: GeometryScope) -> None setVals(arg1: OQuatfGeomParamSample, arg2: object) -> None valid(arg1: OQuatfGeomParamSample) -> bool ``` -------------------------------- ### OScalarProperty Methods (Python) Source: https://docs.alembic.io/python/abc Provides methods for OScalarProperty to get the number of samples, retrieve the parent compound property, set a sample from the previous one, change the time sampling, and set a sample's value. ```python getNumSamples(_(OScalarProperty)arg1_) → int : Return the number of samples contained in this property getParent(_(OScalarProperty)arg1_) → OCompoundProperty : Return the parent OCompoundProperty setFromPrevious(_(OScalarProperty)arg1_) → None : Set a Sample from the previous sample setTimeSampling(_(OScalarProperty)arg1_ , _(int)index_) → None : Change the TimeSampling used by this property with the given index setTimeSampling( (OScalarProperty)arg1, (TimeSampling)TimeSampling) -> None : Change the TimeSampling used by this property with the given TimeSampling setValue(_(OScalarProperty)arg1_ , _(object)value_) → None : Set a sample with the given value ``` -------------------------------- ### OBox2iGeomParam Methods Source: https://docs.alembic.io/python/abcg Provides methods for interacting with OBox2iGeomParam, a typed geometry parameter writer for Alembic. This includes getting and setting data, checking validity, and managing time sampling. ```python from alembic.AbcGeom import OBox2iGeomParam, OBox2iGeomParamSample, GeometryScope, TimeSampling, OBox2iArrayProperty # Example usage (conceptual): # param = OBox2iGeomParam(parent, "paramName") # param.set(sample_data) # scope = param.getScope() # is_valid = param.valid() # num_samples = param.getNumSamples() # time_sampling = param.getTimeSampling() # value_property = param.getValueProperty() # is_indexed = param.isIndexed() # name = param.getName() # data_type = param.getDataType() # param.reset() # param.setFromPrevious() # param.setTimeSampling(index) # param.setTimeSampling(TimeSampling()) ``` -------------------------------- ### Retrieving Mesh Sample Values and Bounds (Python) Source: https://docs.alembic.io/python/examples Shows how to get the actual mesh sample data and its self-bounding box. This is fundamental for accessing and verifying the geometric properties of a mesh. ```python >>> meshSamp = mesh.getValue() >>> assert meshSamp.getSelfBounds().min() == imath.V3d(-1.0, -1.0, -1.0) >>> assert meshSamp.getSelfBounds().max() == imath.V3d( 1.0, 1.0, 1.0) ``` -------------------------------- ### OFaceSetSchemaSample Methods Source: https://docs.alembic.io/python/abcg Methods for interacting with OFaceSetSchemaSample, including getting and setting faces and bounds. ```APIDOC ## getFaces OFaceSetSchemaSample ### Description Retrieves the faces from the OFaceSetSchemaSample. ### Method Not applicable (method of a class instance) ### Endpoint Not applicable (method of a class instance) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body * **arg1** (OFaceSetSchemaSample) - Required - The OFaceSetSchemaSample instance. ### Request Example None ### Response #### Success Response (object) Returns the faces data. #### Response Example ```json { "example": "[face data]" } ``` ## getSelfBounds OFaceSetSchemaSample ### Description Retrieves the bounding box of the OFaceSetSchemaSample. ### Method Not applicable (method of a class instance) ### Endpoint Not applicable (method of a class instance) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body * **arg1** (OFaceSetSchemaSample) - Required - The OFaceSetSchemaSample instance. ### Request Example None ### Response #### Success Response (Box3d) Returns the Box3d representing the bounds. #### Response Example ```json { "example": { "min": [0, 0, 0], "max": [1, 1, 1] } } ``` ## reset OFaceSetSchemaSample ### Description Resets the OFaceSetSchemaSample. ### Method Not applicable (method of a class instance) ### Endpoint Not applicable (method of a class instance) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body * **arg1** (OFaceSetSchemaSample) - Required - The OFaceSetSchemaSample instance. ### Request Example None ### Response #### Success Response (None) This method returns None. #### Response Example None ## setFaces OFaceSetSchemaSample ### Description Sets the faces for the OFaceSetSchemaSample. ### Method Not applicable (method of a class instance) ### Endpoint Not applicable (method of a class instance) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body * **arg1** (OFaceSetSchemaSample) - Required - The OFaceSetSchemaSample instance. * **arg2** (object) - Required - The face data to set. ### Request Example None ### Response #### Success Response (None) This method returns None. #### Response Example None ## setSelfBounds OFaceSetSchemaSample ### Description Sets the bounding box for the OFaceSetSchemaSample. ### Method Not applicable (method of a class instance) ### Endpoint Not applicable (method of a class instance) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body * **arg1** (OFaceSetSchemaSample) - Required - The OFaceSetSchemaSample instance. * **bounds** (Box3d) - Required - The Box3d to set as bounds. ### Request Example None ### Response #### Success Response (None) This method returns None. #### Response Example None ``` -------------------------------- ### Static Utility Methods for Alembic Geometry Parameters Source: https://docs.alembic.io/python/abcg Demonstrates static methods common across Alembic geometry parameter classes. These include retrieving interpretation strings and checking if a property header matches a schema. ```python from alembic.Abc import PropertyHeader, SchemaInterpMatching from alembic.AbcGeom import OBox2iGeomParam, OBox2sGeomParam, OBox3dGeomParam # Example usage (conceptual): # interpretation_type = OBox2iGeomParam.getInterpretation() # header = PropertyHeader(...) # is_strict_match = OBox2sGeomParam.matches(header) # is_lenient_match = OBox3dGeomParam.matches(header, SchemaInterpMatching.kLenientMatching) ``` -------------------------------- ### ICurvesSchema Source: https://docs.alembic.io/python/abcg Provides methods for interacting with curve schemas, including getting properties, sampling, and validation. ```APIDOC ## Class: alembic.AbcGeom.ICurvesSchema ### Description The ICurvesSchema class is a curves schema writer. ### Methods - **get**(arg1: ICurvesSchema, sample: ICurvesSchemaSample, iSS: ISampleSelector = ) - Returns None. - **getKnotsProperty**(arg1: ICurvesSchema) -> IFloatArrayProperty - Returns the knots property. - **getNormalsParam**(arg1: ICurvesSchema) -> IN3fGeomParam - Returns the normals parameter. - **getNumSamples**(arg1: ICurvesSchema) -> int - Returns the number of samples. - **getNumVerticesProperty**(arg1: ICurvesSchema) -> IInt32ArrayProperty - Returns the number of vertices property. - **getOrdersProperty**(arg1: ICurvesSchema) -> IUcharArrayProperty - Returns the orders property. - **getPositionWeightsProperty**(arg1: ICurvesSchema) -> IFloatArrayProperty - Returns the position weights property. - **getPositionsProperty**(arg1: ICurvesSchema) -> IP3fArrayProperty - Returns the positions property. - **getTimeSampling**(arg1: ICurvesSchema) -> TimeSampling - Returns the time sampling. - **getTopologyVariance**(arg1: ICurvesSchema) -> MeshTopologyVariance - Returns the topology variance. - **getUVsParam**(arg1: ICurvesSchema) -> IV2fGeomParam - Returns the UVs parameter. - **getValue**(arg1: ICurvesSchema, iSampSelector: ISampleSelector = ) - Returns ICurvesSchemaSample. - **getVelocitiesProperty**(arg1: ICurvesSchema) -> IV3fArrayProperty - Returns the velocities property. - **getWidthsParam**(arg1: ICurvesSchema) -> IFloatGeomParam - Returns the widths parameter. - **isConstant**(arg1: ICurvesSchema) -> bool - Checks if the schema is constant. - **reset**(arg1: ICurvesSchema) - Resets the schema. Returns None. - **valid**(arg1: ICurvesSchema) -> bool - Checks if the schema is valid. ``` -------------------------------- ### IP3dGeomParam Sample Methods Source: https://docs.alembic.io/python/abcg Defines methods for accessing sample-specific data for 3D geometric parameters. This includes retrieving indices, scope, values, and checking for indexed status, as well as resetting and validating the sample. ```python getIndices(arg1) getScope(arg1) getVals(arg1) isIndexed(arg1) reset(arg1) valid(arg1) ``` -------------------------------- ### Get Alembic Velocities Source: https://docs.alembic.io/python/abcg Retrieves the velocity data associated with the geometry. This is typically used for motion blur and animation. ```python from alembic.AbcGeom import getVelocities # Assuming 'obj' is a valid Alembic object with geometry # velocities = getVelocities(obj) ``` -------------------------------- ### Import Alembic Library Source: https://docs.alembic.io/python/examples This snippet shows the basic Python command to import the Alembic library. Ensure that PyImath is in your PYTHONPATH and Boost::Python is in LD_LIBRARY_PATH. ```python >>> import alembic ``` -------------------------------- ### Get Alembic Geometry Bounds Source: https://docs.alembic.io/python/abcg Retrieves the bounding box of the geometry. This is a fundamental operation for spatial queries and rendering. ```python from alembic.AbcGeom import getSelfBounds # Assuming 'obj' is a valid Alembic object with geometry # bounds = getSelfBounds(obj) ``` -------------------------------- ### Manage Alembic XformOp Translation Source: https://docs.alembic.io/python/abcg Handles translation properties of an Alembic XformOp. This includes getting and setting the translation vector. ```python from alembic.AbcGeom import XformOp from alembic.AbcCoreAbstract import V3d # Assuming 'xform_op' is an instance of XformOp # translation = xform_op.getTranslate() # xform_op.setTranslate(V3d(10.0, 0.0, 0.0)) ``` -------------------------------- ### Manage Alembic XformOp Scale Source: https://docs.alembic.io/python/abcg Handles scaling properties of an Alembic XformOp. This includes getting and setting the scale vector. ```python from alembic.AbcGeom import XformOp from alembic.AbcCoreAbstract import V3d # Assuming 'xform_op' is an instance of XformOp # scale = xform_op.getScale() # xform_op.setScale(V3d(2.0, 2.0, 2.0)) ``` -------------------------------- ### Accessing Indexed UV Sample Data (Python) Source: https://docs.alembic.io/python/examples Demonstrates how to retrieve indexed UV sample data and access specific UV coordinates. This is used for verifying UV mapping correctness. ```python >>> uvsamp = uv.getIndexedValue() >>> assert uvsamp.getIndices()[1] == 1 >>> uv2 = uvsamp.getVals()[2] >>> assert uv2 == V2f(1.0, 1.0) ``` -------------------------------- ### OBaseProperty Methods Source: https://docs.alembic.io/python/abc This section details the common methods available for OBaseProperty and its subclasses, allowing interaction with property data and metadata. ```APIDOC ## OBaseProperty Methods ### Description Provides common methods for interacting with property objects, including retrieving data types, headers, metadata, names, and checking property characteristics. ### Methods - `getDataType()`: Returns the DataType of the property. - `getHeader()`: Returns the PropertyHeader of the property. - `getMetaData()`: Returns the MetaData of the property. - `getName()`: Returns the local name of the property. - `getObject()`: Returns the OObject associated with this property. - `getPropertyType()`: Returns the type of the property. - `getTimeSampling()`: Returns the TimeSampling of the property. - `isArray()`: Returns True if the property is an array. - `isCompound()`: Returns True if the property is a compound type. - `isScalar()`: Returns True if the property is a scalar type. - `isSimple()`: Returns True if the property is simple (non-compound). - `reset()`: Resets the property to an empty state. - `valid()`: Returns True if the property is valid. ``` -------------------------------- ### Get Alembic Subdivision Scheme Source: https://docs.alembic.io/python/abcg Retrieves the subdivision scheme used for the geometry. This is important for smooth surfaces and detailed rendering. ```python from alembic.AbcGeom import getSubdivisionScheme # Assuming 'obj' is a valid Alembic object with geometry # scheme = getSubdivisionScheme(obj) ``` -------------------------------- ### OP2fProperty Source: https://docs.alembic.io/python/abc Represents a typed scalar property writer for floating-point numbers. Includes methods for getting the interpretation and performing matches. ```APIDOC ## OP2fProperty ### Description This class is a typed scalar property writer. ### Methods #### getInterpretation - **Returns**: (str) The interpretation string expected of this property. #### matches (static) - **Description**: Return True if the given entity (as represented by a metadata) strictly matches the interpretation of this typed property. - **Parameters**: - **metaData** (MetaData) - The metadata object to match against. - **matchingSchema** (SchemaInterpMatching) - Optional. Defaults to alembic.Abc.SchemaInterpMatching.kStrictMatching. The schema matching strategy. - **Returns**: (bool) True if the metadata matches, False otherwise. #### matches - **Description**: Return True if the given entity (as represented by a property header) strictly matches the interpretation of this typed property, as well as the data type. - **Parameters**: - **propertyHeader** (PropertyHeader) - The property header to match against. - **matchingSchema** (SchemaInterpMatching) - Optional. Defaults to alembic.Abc.SchemaInterpMatching.kStrictMatching. The schema matching strategy. - **Returns**: (bool) True if the property header matches, False otherwise. ``` -------------------------------- ### OStringArrayProperty Methods Source: https://docs.alembic.io/python/abc Documentation for the OStringArrayProperty class, including its static `matches` method. ```APIDOC ## OStringArrayProperty ### Description This class is a typed array property writer. ### Methods - `getInterpretation()`: Returns the interpretation string expected of this property. ### Static Methods - `matches(metaData, matchingSchema)`: Returns True if the given entity (as represented by a metadata) strictly matches the interpretation of this typed property. ``` -------------------------------- ### Manage Alembic XformOp Rotation Source: https://docs.alembic.io/python/abcg Handles rotation-related properties of an Alembic XformOp. This includes getting and setting the rotation angle and axis. ```python from alembic.AbcGeom import XformOp from alembic.AbcCoreAbstract import V3d # Assuming 'xform_op' is an instance of XformOp # angle = xform_op.getAngle() # axis = xform_op.getAxis() # xform_op.setAngle(45.0) # xform_op.setAxis(V3d(1.0, 0.0, 0.0)) ``` -------------------------------- ### OBox2fGeomParam Methods Source: https://docs.alembic.io/python/abcg Methods for managing 2D box geometry parameters (float precision). ```APIDOC ## OBox2fGeomParam Methods ### Description This class is a typed geom param writer for 2D boxes (float precision). ### Methods #### `getDataType(arg1)` * **Description**: Retrieves the data type of the geometry parameter. * **Parameters**: * `arg1` (OBox2fGeomParam) - The geometry parameter. * **Returns**: DataType - The data type. #### `getIndexProperty(arg1)` * **Description**: Retrieves the index property of the geometry parameter. * **Parameters**: * `arg1` (OBox2fGeomParam) - The geometry parameter. * **Returns**: OUInt32ArrayProperty - The index property. #### `getInterpretation()` * **Description**: Retrieves the interpretation string for this class. * **Returns**: str - The interpretation string. #### `getName(arg1)` * **Description**: Retrieves the name of the geometry parameter. * **Parameters**: * `arg1` (OBox2fGeomParam) - The geometry parameter. * **Returns**: str - The name of the parameter. #### `getNumSamples(arg1)` * **Description**: Retrieves the number of samples for the geometry parameter. * **Parameters**: * `arg1` (OBox2fGeomParam) - The geometry parameter. * **Returns**: int - The number of samples. #### `getScope(arg1)` * **Description**: Retrieves the geometry scope. * **Parameters**: * `arg1` (OBox2fGeomParam) - The geometry parameter. * **Returns**: GeometryScope - The geometry scope. #### `getTimeSampling(arg1)` * **Description**: Retrieves the time sampling information. * **Parameters**: * `arg1` (OBox2fGeomParam) - The geometry parameter. * **Returns**: TimeSampling - The time sampling object. #### `getValueProperty(arg1)` * **Description**: Retrieves the value property of the geometry parameter. * **Parameters**: * `arg1` (OBox2fGeomParam) - The geometry parameter. * **Returns**: OBox2fArrayProperty - The value property. #### `isIndexed(arg1)` * **Description**: Checks if the geometry parameter is indexed. * **Parameters**: * `arg1` (OBox2fGeomParam) - The geometry parameter. * **Returns**: bool - True if indexed, false otherwise. #### `matches(header, matchingSchema)` * **Description**: Checks if the given header matches the expected schema. * **Parameters**: * `header` (PropertyHeader) - The property header to check. * `matchingSchema` (SchemaInterpMatching) - Optional. The schema matching mode. Defaults to alembic.Abc.SchemaInterpMatching.kStrictMatching. * **Returns**: bool - True if the header matches, false otherwise. #### `reset(arg1)` * **Description**: Resets the geometry parameter. * **Parameters**: * `arg1` (OBox2fGeomParam) - The geometry parameter to reset. * **Returns**: None #### `set(arg1, sample)` * **Description**: Sets the geometry parameter with a new sample. * **Parameters**: * `arg1` (OBox2fGeomParam) - The geometry parameter to set. * `sample` (object) - The sample data to set. * **Returns**: None #### `setFromPrevious(arg1)` * **Description**: Sets the geometry parameter from the previous sample. * **Parameters**: * `arg1` (OBox2fGeomParam) - The geometry parameter to set. * **Returns**: None #### `setTimeSampling(arg1, index)` * **Description**: Sets the time sampling for the geometry parameter. * **Parameters**: * `arg1` (OBox2fGeomParam) - The geometry parameter. * `index` (int) - The index for time sampling. * **Returns**: None #### `setTimeSampling(arg1, TimeSampling)` * **Description**: Sets the time sampling for the geometry parameter using a TimeSampling object. * **Parameters**: * `arg1` (OBox2fGeomParam) - The geometry parameter. * `TimeSampling` (TimeSampling) - The TimeSampling object. * **Returns**: None #### `valid(arg1)` * **Description**: Checks if the geometry parameter is valid. * **Parameters**: * `arg1` (OBox2fGeomParam) - The geometry parameter to validate. * **Returns**: bool - True if valid, false otherwise. ``` -------------------------------- ### OP2iGeomParamSample Source: https://docs.alembic.io/python/abcg Provides functionality to manage samples for 2D integer geometry parameters, including getting and setting indices, scope, and values. ```APIDOC ## OP2iGeomParamSample ### Description Represents a sample for a 2D integer geometry parameter. ### Methods - `getIndices(arg1: OP2iGeomParamSample) -> object` - `getScope(arg1: OP2iGeomParamSample) -> GeometryScope` - `getVals(arg1: OP2iGeomParamSample) -> object` - `reset(arg1: OP2iGeomParamSample) -> None` - `setIndices(arg1: OP2iGeomParamSample, arg2: object) -> None` - `setScope(arg1: OP2iGeomParamSample, scope: GeometryScope) -> None` - `setVals(arg1: OP2iGeomParamSample, arg2: object) -> None` - `valid(arg1: OP2iGeomParamSample) -> bool` ``` -------------------------------- ### Alembic OBox3fGeomParamSample: Sample Operations for 3D Float Bounding Box Geometry Source: https://docs.alembic.io/python/abcg The OBox3fGeomParamSample class handles samples for Alembic's OBox3fGeomParam, allowing for the manipulation of float-based 3D bounding box data. It includes methods for setting and getting sample values, indices, and scope, enabling precise control over geometric parameterization over time. ```python class OBox3fGeomParamSample: def getIndices(self) -> object: pass def getScope(self) -> GeometryScope: pass def getVals(self) -> object: pass def reset(self) -> None: pass def setIndices(self, arg2: object) -> None: pass def setScope(self, scope: GeometryScope) -> None: pass def setVals(self, arg2: object) -> None: pass def valid(self) -> bool: pass ``` -------------------------------- ### OBox2fGeomParamSample Methods Source: https://docs.alembic.io/python/abcg Methods for interacting with samples of 2D box geometry parameters (float precision). ```APIDOC ## OBox2fGeomParamSample Methods ### Description Provides methods for accessing and modifying samples of 2D box geometry parameters (float precision). ### Methods #### `getIndices(arg1)` * **Description**: Retrieves the indices from the sample. * **Parameters**: * `arg1` (OBox2fGeomParamSample) - The sample object. * **Returns**: object - The indices. #### `getScope(arg1)` * **Description**: Retrieves the geometry scope from the sample. * **Parameters**: * `arg1` (OBox2fGeomParamSample) - The sample object. * **Returns**: GeometryScope - The geometry scope. #### `getVals(arg1)` * **Description**: Retrieves the values from the sample. * **Parameters**: * `arg1` (OBox2fGeomParamSample) - The sample object. * **Returns**: object - The values. #### `reset(arg1)` * **Description**: Resets the sample. * **Parameters**: * `arg1` (OBox2fGeomParamSample) - The sample object to reset. * **Returns**: None #### `setIndices(arg1, arg2)` * **Description**: Sets the indices for the sample. * **Parameters**: * `arg1` (OBox2fGeomParamSample) - The sample object. * `arg2` (object) - The indices to set. * **Returns**: None #### `setScope(arg1, scope)` * **Description**: Sets the geometry scope for the sample. * **Parameters**: * `arg1` (OBox2fGeomParamSample) - The sample object. * `scope` (GeometryScope) - The geometry scope to set. * **Returns**: None #### `setVals(arg1, arg2)` * **Description**: Sets the values for the sample. * **Parameters**: * `arg1` (OBox2fGeomParamSample) - The sample object. * `arg2` (object) - The values to set. * **Returns**: None #### `valid(arg1)` * **Description**: Checks if the sample is valid. * **Parameters**: * `arg1` (OBox2fGeomParamSample) - The sample object to validate. * **Returns**: bool - True if valid, false otherwise. ``` -------------------------------- ### Alembic Geometry Query Functions Source: https://docs.alembic.io/python/abcg Utility functions for querying Alembic geometry data, such as getting archive bounds and visibility information. ```python GetIArchiveBounds(IArchive, Argument, Argument) -> IBox3dProperty GetVisibility(IObject, ISampleSelector) -> ObjectVisibility GetVisibilityProperty(IObject) -> ICharProperty ``` -------------------------------- ### Get WstringTPTraits Interpretation String Source: https://docs.alembic.io/python/abc Returns the interpretation string for the WstringTPTraits property type. This static method describes how the data is interpreted. ```python from alembic.Abc import WstringTPTraits interpretation = WstringTPTraits.interpretation() ``` -------------------------------- ### Manage XformSample Topology and Operations (Python) Source: https://docs.alembic.io/python/abcg Covers methods for managing the topology and individual operations within an XformSample. This includes checking for topology equality, resetting the sample, and retrieving specific operations by index. ```python from alembic.AbcGeom import XformSample sample1 = XformSample() sample2 = XformSample() # Assume operations are added to sample1 and sample2 is_equal = sample1.isTopologyEqual(sample2) num_ops = sample1.getNumOps() num_channels = sample1.getNumOpChannels() first_op = sample1.getOp(0) sample1.reset() ``` -------------------------------- ### Get WstringTPTraits DataType Source: https://docs.alembic.io/python/abc Retrieves the DataType for the WstringTPTraits property type. This static method provides information about the underlying data representation. ```python from alembic.Abc import WstringTPTraits data_type = WstringTPTraits.dataType() ``` -------------------------------- ### Get Interpretation String (Python) Source: https://docs.alembic.io/python/abc This method returns the interpretation string that is expected of the property. This is common across several property types. ```python getInterpretation() → str : Return the interpretation string expected of this property ``` -------------------------------- ### OBox2dGeomParam Methods Source: https://docs.alembic.io/python/abcg Methods for managing 2D box geometry parameters (double precision). ```APIDOC ## OBox2dGeomParam Methods ### Description This class is a typed geom param writer for 2D boxes (double precision). ### Methods #### `getDataType(arg1)` * **Description**: Retrieves the data type of the geometry parameter. * **Parameters**: * `arg1` (OBox2dGeomParam) - The geometry parameter. * **Returns**: DataType - The data type. #### `getIndexProperty(arg1)` * **Description**: Retrieves the index property of the geometry parameter. * **Parameters**: * `arg1` (OBox2dGeomParam) - The geometry parameter. * **Returns**: OUInt32ArrayProperty - The index property. #### `getInterpretation()` * **Description**: Retrieves the interpretation string for this class. * **Returns**: str - The interpretation string. #### `getName(arg1)` * **Description**: Retrieves the name of the geometry parameter. * **Parameters**: * `arg1` (OBox2dGeomParam) - The geometry parameter. * **Returns**: str - The name of the parameter. #### `getNumSamples(arg1)` * **Description**: Retrieves the number of samples for the geometry parameter. * **Parameters**: * `arg1` (OBox2dGeomParam) - The geometry parameter. * **Returns**: int - The number of samples. #### `getScope(arg1)` * **Description**: Retrieves the geometry scope. * **Parameters**: * `arg1` (OBox2dGeomParam) - The geometry parameter. * **Returns**: GeometryScope - The geometry scope. #### `getTimeSampling(arg1)` * **Description**: Retrieves the time sampling information. * **Parameters**: * `arg1` (OBox2dGeomParam) - The geometry parameter. * **Returns**: TimeSampling - The time sampling object. #### `getValueProperty(arg1)` * **Description**: Retrieves the value property of the geometry parameter. * **Parameters**: * `arg1` (OBox2dGeomParam) - The geometry parameter. * **Returns**: OBox2dArrayProperty - The value property. #### `isIndexed(arg1)` * **Description**: Checks if the geometry parameter is indexed. * **Parameters**: * `arg1` (OBox2dGeomParam) - The geometry parameter. * **Returns**: bool - True if indexed, false otherwise. #### `matches(header, matchingSchema)` * **Description**: Checks if the given header matches the expected schema. * **Parameters**: * `header` (PropertyHeader) - The property header to check. * `matchingSchema` (SchemaInterpMatching) - Optional. The schema matching mode. Defaults to alembic.Abc.SchemaInterpMatching.kStrictMatching. * **Returns**: bool - True if the header matches, false otherwise. #### `reset(arg1)` * **Description**: Resets the geometry parameter. * **Parameters**: * `arg1` (OBox2dGeomParam) - The geometry parameter to reset. * **Returns**: None #### `set(arg1, sample)` * **Description**: Sets the geometry parameter with a new sample. * **Parameters**: * `arg1` (OBox2dGeomParam) - The geometry parameter to set. * `sample` (object) - The sample data to set. * **Returns**: None #### `setFromPrevious(arg1)` * **Description**: Sets the geometry parameter from the previous sample. * **Parameters**: * `arg1` (OBox2dGeomParam) - The geometry parameter to set. * **Returns**: None #### `setTimeSampling(arg1, index)` * **Description**: Sets the time sampling for the geometry parameter. * **Parameters**: * `arg1` (OBox2dGeomParam) - The geometry parameter. * `index` (int) - The index for time sampling. * **Returns**: None #### `setTimeSampling(arg1, TimeSampling)` * **Description**: Sets the time sampling for the geometry parameter using a TimeSampling object. * **Parameters**: * `arg1` (OBox2dGeomParam) - The geometry parameter. * `TimeSampling` (TimeSampling) - The TimeSampling object. * **Returns**: None #### `valid(arg1)` * **Description**: Checks if the geometry parameter is valid. * **Parameters**: * `arg1` (OBox2dGeomParam) - The geometry parameter to validate. * **Returns**: bool - True if valid, false otherwise. ``` -------------------------------- ### Alembic OInt64GeomParam Sample Methods Source: https://docs.alembic.io/python/abcg Methods for manipulating OInt64GeomParamSample objects, allowing for the retrieval and setting of indices, scope, and values. These are essential for working with sample data for 64-bit integer geometry parameters. ```python class OInt64GeomParamSample: def getIndices(self, arg1: object) -> object: pass def getScope(self, arg1: object) -> GeometryScope: pass def getVals(self, arg1: object) -> object: pass def reset(self, arg1: object) -> None: pass def setIndices(self, arg1: object, arg2: object) -> None: pass def setScope(self, arg1: object, scope: GeometryScope) -> None: pass def setVals(self, arg1: object, arg2: object) -> None: pass def valid(self, arg1: object) -> bool: pass ``` -------------------------------- ### OP2sArrayProperty Source: https://docs.alembic.io/python/abc Represents a typed array property writer for string values. Includes methods to get the interpretation string and perform matches. ```APIDOC ## OP2sArrayProperty ### Description This class is a typed array property writer. ### Methods #### getInterpretation - **Returns**: (str) The interpretation string expected of this property. #### matches (static) - **Description**: Return True if the given entity (as represented by a metadata) strictly matches the interpretation of this typed property. - **Parameters**: - **metaData** (MetaData) - The metadata object to match against. - **matchingSchema** (SchemaInterpMatching) - Optional. Defaults to alembic.Abc.SchemaInterpMatching.kStrictMatching. The schema matching strategy. - **Returns**: (bool) True if the metadata matches, False otherwise. #### matches - **Description**: Return True if the given entity (as represented by a property header) strictly matches the interpretation of this typed property, as well as the data type. - **Parameters**: - **propertyHeader** (PropertyHeader) - The property header to match against. - **matchingSchema** (SchemaInterpMatching) - Optional. Defaults to alembic.Abc.SchemaInterpMatching.kStrictMatching. The schema matching strategy. - **Returns**: (bool) True if the property header matches, False otherwise. ``` -------------------------------- ### Get Alembic Library Version Source: https://docs.alembic.io/python/abc Retrieves the version of the Alembic library. The GetLibraryVersionShort function also includes the date the library was built. ```python import alembic.Abc version = alembic.Abc.GetLibraryVersion() print(f"Alembic Version: {version}") version_short = alembic.Abc.GetLibraryVersionShort() print(f"Alembic Version (Short): {version_short}") ``` -------------------------------- ### OPolyMeshSchema Methods (Python) Source: https://docs.alembic.io/python/abcg Provides methods for interacting with an OPolyMeshSchema object. These include getting the number of samples, time sampling information, face set existence, resetting the schema, setting sample data, setting from previous data, setting time sampling, and validating the schema. ```python getNumSamples(arg1: OPolyMeshSchema) -> int getTimeSampling(arg1: OPolyMeshSchema) -> TimeSampling hasFaceSet(arg1: OPolyMeshSchema, iFaceSetName: str) -> bool reset(arg1: OPolyMeshSchema) -> None set(arg1: OPolyMeshSchema, iSamp: OPolyMeshSchemaSample) -> None setFromPrevious(arg1: OPolyMeshSchema) -> None setTimeSampling(arg1: OPolyMeshSchema, index: int) -> None setTimeSampling(arg1: OPolyMeshSchema, TimeSampling: TimeSampling) -> None setUVSourceName(arg1: OPolyMeshSchema, arg2: str) -> None valid(arg1: OPolyMeshSchema) -> bool ``` -------------------------------- ### OBox2iGeomParamSample Methods Source: https://docs.alembic.io/python/abcg Details the methods for OBox2iGeomParamSample, used to represent a sample of OBox2iGeomParam data. Allows setting and getting indices, scope, and values. ```python from alembic.AbcGeom import OBox2iGeomParamSample, GeometryScope # Example usage (conceptual): # sample = OBox2iGeomParamSample() # sample.setScope(GeometryScope.kFaceScope) # current_scope = sample.getScope() # sample.setIndices(indices_data) # indices = sample.getIndices() # sample.setVals(values_data) # values = sample.getVals() # sample.reset() # is_valid = sample.valid() ``` -------------------------------- ### IBox2dProperty Static Methods Source: https://docs.alembic.io/python/abc Static methods for the IBox2dProperty class, used for interpretation and matching. ```APIDOC ## IBox2dProperty Static Methods ### Description Static methods to determine the interpretation and compatibility of a 2D box property. ### Methods - `getInterpretation() -> str` Return the interpretation string expected of this property. - `matches(metaData: MetaData, matchingSchema: SchemaInterpMatching = alembic.Abc.SchemaInterpMatching.kStrictMatching) -> bool` Return True if the given entity (as represented by a metadata) strictly matches the interpretation of this typed property. - `matches(propertyHeader: PropertyHeader, matchingSchema: SchemaInterpMatching = alembic.Abc.SchemaInterpMatching.kStrictMatching) -> bool` Return True if the given entity (as represented by a property header) strictly matches the interpretation of this typed property, as well as the data type. ``` -------------------------------- ### OP2dProperty Source: https://docs.alembic.io/python/abc Represents a typed scalar property writer. Provides methods to get its interpretation string and check for matches against metadata or property headers. ```APIDOC ## OP2dProperty ### Description This class is a typed scalar property writer. ### Methods #### getInterpretation - **Returns**: (str) The interpretation string expected of this property. #### matches (static) - **Description**: Return True if the given entity (as represented by a metadata) strictly matches the interpretation of this typed property. - **Parameters**: - **metaData** (MetaData) - The metadata object to match against. - **matchingSchema** (SchemaInterpMatching) - Optional. Defaults to alembic.Abc.SchemaInterpMatching.kStrictMatching. The schema matching strategy. - **Returns**: (bool) True if the metadata matches, False otherwise. #### matches - **Description**: Return True if the given entity (as represented by a property header) strictly matches the interpretation of this typed property, as well as the data type. - **Parameters**: - **propertyHeader** (PropertyHeader) - The property header to match against. - **matchingSchema** (SchemaInterpMatching) - Optional. Defaults to alembic.Abc.SchemaInterpMatching.kStrictMatching. The schema matching strategy. - **Returns**: (bool) True if the property header matches, False otherwise. ``` -------------------------------- ### OBox2dGeomParamSample Methods Source: https://docs.alembic.io/python/abcg Methods for interacting with samples of 2D box geometry parameters (double precision). ```APIDOC ## OBox2dGeomParamSample Methods ### Description Provides methods for accessing and modifying samples of 2D box geometry parameters (double precision). ### Methods #### `getIndices(arg1)` * **Description**: Retrieves the indices from the sample. * **Parameters**: * `arg1` (OBox2dGeomParamSample) - The sample object. * **Returns**: object - The indices. #### `getScope(arg1)` * **Description**: Retrieves the geometry scope from the sample. * **Parameters**: * `arg1` (OBox2dGeomParamSample) - The sample object. * **Returns**: GeometryScope - The geometry scope. #### `getVals(arg1)` * **Description**: Retrieves the values from the sample. * **Parameters**: * `arg1` (OBox2dGeomParamSample) - The sample object. * **Returns**: object - The values. #### `reset(arg1)` * **Description**: Resets the sample. * **Parameters**: * `arg1` (OBox2dGeomParamSample) - The sample object to reset. * **Returns**: None #### `setIndices(arg1, arg2)` * **Description**: Sets the indices for the sample. * **Parameters**: * `arg1` (OBox2dGeomParamSample) - The sample object. * `arg2` (object) - The indices to set. * **Returns**: None #### `setScope(arg1, scope)` * **Description**: Sets the geometry scope for the sample. * **Parameters**: * `arg1` (OBox2dGeomParamSample) - The sample object. * `scope` (GeometryScope) - The geometry scope to set. * **Returns**: None #### `setVals(arg1, arg2)` * **Description**: Sets the values for the sample. * **Parameters**: * `arg1` (OBox2dGeomParamSample) - The sample object. * `arg2` (object) - The values to set. * **Returns**: None #### `valid(arg1)` * **Description**: Checks if the sample is valid. * **Parameters**: * `arg1` (OBox2dGeomParamSample) - The sample object to validate. * **Returns**: bool - True if valid, false otherwise. ``` -------------------------------- ### IBox3iGeomParamSample Methods Source: https://docs.alembic.io/python/abcg Methods for interacting with IBox3iGeomParamSample, representing a single sample of a 3D integer bounding box geometry parameter. ```APIDOC ## IBox3iGeomParamSample ### Methods - **getIndices**(_(IBox3iGeomParamSample)arg1_) → object - Description: Retrieves the indices for this sample. - **getScope**(_(IBox3iGeomParamSample)arg1_) → GeometryScope - Description: Gets the scope of this sample. - **getVals**(_(IBox3iGeomParamSample)arg1_) → object - Description: Retrieves the values for this sample. - **isIndexed**(_(IBox3iGeomParamSample)arg1_) → bool - Description: Checks if this sample is indexed. - **reset**(_(IBox3iGeomParamSample)arg1_) → None - Description: Resets the sample reader. - **valid**(_(IBox3iGeomParamSample)arg1_) → bool - Description: Checks if this sample is valid. ``` -------------------------------- ### Manage Alembic XformOp Matrix Source: https://docs.alembic.io/python/abcg Handles matrix transformation data within an Alembic XformOp. This includes getting and setting the 4x4 transformation matrix. ```python from alembic.AbcGeom import XformOp from alembic.AbcCoreAbstract import M44d # Assuming 'xform_op' is an instance of XformOp # matrix = xform_op.getMatrix() # xform_op.setMatrix(M44d(....)) ```