I3DInstance¶
- class I3DInstance¶
Bases:
ImpactCOMWrapperBase- Summary:
Represents a 3D instance.
- Remarks:
Introduced in Impact 11.0.0.39
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property extents¶
Gets Extents.
- Summary:
Gets the extents of the bounding box of the instance,
- Remarks:
Introduced in Impact 12.0.0.136
- Returns:
The value of Extents.
- Return type:
extents (i3_d_rect)
Examples:
- property guid¶
Gets GUID.
- Summary:
Gets the GUID of the instance.
- Remarks:
Introduced in Impact 11.0.0.39
- Returns:
The value of GUID.
- Return type:
guid (str)
- property locked¶
Gets Locked.
- Summary:
Gets and sets if the instance is locked.
- Remarks:
Introduced in Impact 12.0.0.136
- Returns:
The value of Locked.
- Return type:
locked (bool)
Examples:
- property matrix¶
Gets Matrix.
- Summary:
Gets and sets the transformation matrix representing the position and orientation of the 3D instance.
- Remarks:
The matrix describes the position, scaling, mirroring and rotation of the instance within the scene. Introduced in Impact 12.0.0.136
- Returns:
The value of Matrix.
- Return type:
matrix (i3_d_matrix)
Examples:
- property name¶
Gets Name.
- Summary:
Gets and sets the name of the instance.
- Remarks:
Introduced in Impact 11.0.0.39
- Returns:
The value of Name.
- Return type:
name (str)
- property origin¶
Gets Origin.
- Summary:
Gets the sets the origin (base position).
- Remarks:
Introduced in Impact 12.0.0.136
- Returns:
The value of Origin.
- Return type:
origin (i3_d_vector)
Examples:
- property position¶
Gets Position.
- Summary:
Gets and sets the model’s position in the scene.
- Remarks:
Introduced in Impact 12.0.0.136
- Returns:
The value of Position.
- Return type:
position (i3_d_vector)
- property selected¶
Gets Selected.
- Summary:
Gets and sets if the instance is selected.
- Remarks:
Introduced in Impact 11.0.0.39
- Returns:
The value of Selected.
- Return type:
selected (bool)
- property visible¶
Gets Visible.
- Summary:
Gets and sets if the instance is visible.
- Remarks:
Introduced in Impact 11.0.0.39
- Returns:
The value of Visible.
- Return type:
visible (bool)
- copy()¶
- Summary:
Makes an identical copy of the instance
- Remarks:
Introduced in Impact 12.0.0.136
Examples:
- delete()¶
- Summary:
Deletes this instance
- Remarks:
Introduced in Impact 12.0.0.136
Examples:
- isNone()¶
Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.
- object()¶
- Summary:
Returns an i3_d_object object that can be used to access the i3_d_model within the scene.
- Remarks:
Introduced in Impact 11.0.0.39
- transform(matrix)¶
- Summary:
Transforms the instance using the specified transformation matrix.
- Remarks:
Introduced in Impact 12.0.0.136
- Parameters:
matrix (i3_d_matrix) – The transformation matrix to be applied to the instance.
Examples: