fiftyone.core.threed.object_3d.Object3D

class documentation

class Object3D(object): (source)

Known subclasses: fiftyone.core.threed.lights.Light, fiftyone.core.threed.mesh.Mesh, fiftyone.core.threed.pointcloud.PointCloud, fiftyone.core.threed.scene_3d.Scene

Constructor: Object3D(name, visible, position, scale, quaternion)

View In Hierarchy

The base class for all 3D objects in the scene.

Parameters
namethe name of the object
visibledefault visibility of the object in the scene
positionthe position of the object in object space
quaternionthe quaternion of the object in object space
scalethe scale of the object in object space
Method __eq__ Undocumented
Method __init__ Undocumented
Method __iter__ Undocumented
Method __repr__ Undocumented
Method __str__ Undocumented
Method add Add one or more objects as children of this one.
Method as_dict Converts the object to a dict.
Method clear Remove all children from this object.
Method local_transform_matrix.setter Undocumented
Method position.setter Undocumented
Method quaternion.setter Undocumented
Method rotation.setter Undocumented
Method scale.setter Undocumented
Method traverse Traverse the scene graph.
Instance Variable children Undocumented
Instance Variable name Undocumented
Instance Variable visible Undocumented
Property local_transform_matrix The local transform matrix of the object.
Property position The position of the object in object space.
Property quaternion The quaternion of the object in object space.
Property rotation The rotation of the object in object space.
Property scale The scale of the object in object space.
Property uuid The unique ID of the object.
Static Method _from_dict Creates an Object3D (or its subclass) from a dict.
Method _get_asset_paths Get asset paths for this node
Method _to_dict_extra Returns the extra data to include in the dict representation.
Method _update_matrix Undocumented
Class Variable _asset_path_fields Undocumented
Instance Variable _local_transform_matrix Undocumented
Instance Variable _position Undocumented
Instance Variable _quaternion Undocumented
Instance Variable _rotation Undocumented
Instance Variable _scale Undocumented
Instance Variable _uuid Undocumented
def __eq__(self, other): (source)

Undocumented

def __init__(self, name: str, visible=True, position: Vec3UnionType | None = None, scale: Vec3UnionType | None = None, quaternion: Quaternion | None = None): (source)
overridden in fiftyone.core.threed.lights.Light, fiftyone.core.threed.mesh.Mesh, fiftyone.core.threed.pointcloud.PointCloud, fiftyone.core.threed.scene_3d.Scene

Undocumented

def __iter__(self): (source)

Undocumented

def __repr__(self): (source)
overridden in fiftyone.core.threed.lights.AmbientLight, fiftyone.core.threed.lights.DirectionalLight, fiftyone.core.threed.lights.PointLight, fiftyone.core.threed.lights.SpotLight, fiftyone.core.threed.scene_3d.Scene

Undocumented

def __str__(self): (source)

Undocumented

def add(self, *objs: Object3D): (source)

Add one or more objects as children of this one.

def as_dict(self): (source)

Converts the object to a dict.

def clear(self): (source)

Remove all children from this object.

@local_transform_matrix.setter
def local_transform_matrix(self, value: np.ndarray): (source)

Undocumented

@position.setter
def position(self, value: Vec3UnionType): (source)

Undocumented

@quaternion.setter
def quaternion(self, value: Quaternion | list[float] | tuple[float, ...]): (source)

Undocumented

@rotation.setter
def rotation(self, value: Euler | list[float] | tuple[float, ...]): (source)

Undocumented

@scale.setter
def scale(self, value: Vec3UnionType): (source)

Undocumented

def traverse(self, include_self=True): (source)
overridden in fiftyone.core.threed.scene_3d.Scene

Traverse the scene graph.

children: list = (source)

Undocumented

name = (source)
overridden in fiftyone.core.threed.lights.AmbientLight, fiftyone.core.threed.lights.DirectionalLight, fiftyone.core.threed.lights.PointLight, fiftyone.core.threed.lights.SpotLight, fiftyone.core.threed.mesh.FbxMesh, fiftyone.core.threed.mesh.GltfMesh, fiftyone.core.threed.mesh.ObjMesh, fiftyone.core.threed.mesh.PlyMesh, fiftyone.core.threed.mesh.StlMesh, fiftyone.core.threed.pointcloud.PointCloud, fiftyone.core.threed.shape_3d.BoxGeometry, fiftyone.core.threed.shape_3d.CylinderGeometry, fiftyone.core.threed.shape_3d.PlaneGeometry, fiftyone.core.threed.shape_3d.SphereGeometry

Undocumented

visible: True = (source)
overridden in fiftyone.core.threed.lights.Light, fiftyone.core.threed.mesh.Mesh, fiftyone.core.threed.pointcloud.PointCloud

Undocumented

@property
local_transform_matrix = (source)

The local transform matrix of the object.

Setting this property also decomposes the matrix into its constituent position, quaternion, and scale components. However, decomposition of matrices with skew / shear components (non-uniform scaling) might have unexpected results.

@property
position = (source)
overridden in fiftyone.core.threed.lights.Light, fiftyone.core.threed.mesh.Mesh, fiftyone.core.threed.pointcloud.PointCloud

The position of the object in object space.

@property
quaternion = (source)
overridden in fiftyone.core.threed.lights.Light, fiftyone.core.threed.mesh.Mesh, fiftyone.core.threed.pointcloud.PointCloud

The quaternion of the object in object space.

@property
rotation = (source)

The rotation of the object in object space.

@property
scale = (source)
overridden in fiftyone.core.threed.lights.Light, fiftyone.core.threed.mesh.Mesh, fiftyone.core.threed.pointcloud.PointCloud

The scale of the object in object space.

@property
uuid = (source)

The unique ID of the object.

@staticmethod
def _from_dict(dict_data: dict): (source)

Creates an Object3D (or its subclass) from a dict.

def _get_asset_paths(self) -> list[str]: (source)

Get asset paths for this node

def _to_dict_extra(self): (source)
overridden in fiftyone.core.threed.lights.Light, fiftyone.core.threed.mesh.Mesh, fiftyone.core.threed.pointcloud.PointCloud, fiftyone.core.threed.scene_3d.Scene

Returns the extra data to include in the dict representation.

def _update_matrix(self): (source)

Undocumented

_asset_path_fields: list = (source)
overridden in fiftyone.core.threed.mesh.FbxMesh, fiftyone.core.threed.mesh.GltfMesh, fiftyone.core.threed.mesh.ObjMesh, fiftyone.core.threed.mesh.PlyMesh, fiftyone.core.threed.mesh.StlMesh, fiftyone.core.threed.pointcloud.PointCloud

Undocumented

_local_transform_matrix = (source)

Undocumented

_position = (source)

Undocumented

_quaternion = (source)

Undocumented

_rotation = (source)

Undocumented

_scale = (source)

Undocumented

_uuid = (source)

Undocumented