«

fiftyone.core.threed.scene_3d.SceneBackground

class documentation

class SceneBackground(BaseValidatedDataClass): (source)

Constructor: SceneBackground(color, image, cube, intensity)

View In Hierarchy

Represents the background of the scene.

Parameters
colorthe background color of the scene
imagethe path to the background image. Defaults to None. This takes precedence over color if provided
cubethe paths to the six faces of the background. The order of the faces is: +X, -X, +Y, -Y, +Z, -Z. Defaults to None. This takes precedence over the image and color if provided. This can be used to build a skybox
intensitythe intensity of the background. Defaults to 1.0. This only applies for image and cube backgrounds
Method __init__ Undocumented
Method as_dict Undocumented
Method color.setter Undocumented
Method cube.setter Undocumented
Method image.setter Undocumented
Method intensity.setter Undocumented
Property color Undocumented
Property cube Undocumented
Property image Undocumented
Property intensity Undocumented
Static Method _from_dict Undocumented
Instance Variable _color Undocumented
Instance Variable _cube Undocumented
Instance Variable _image Undocumented
Instance Variable _intensity Undocumented

Inherited from BaseValidatedDataClass:

Method __eq__ Undocumented
Method __repr__ Undocumented
Method __setattr__ Undocumented
def __init__(self, color: str | None = None, image: str | None = None, cube: list[str] | None = None, intensity: float | None = 1.0): (source)

Undocumented

def as_dict(self) -> dict: (source)

Undocumented

@color.setter
def color(self, value: str | None): (source)

Undocumented

@cube.setter
def cube(self, value: list[str] | None): (source)

Undocumented

@image.setter
def image(self, value: str | None): (source)

Undocumented

@intensity.setter
def intensity(self, value: float | None): (source)

Undocumented

@property
color: str | None = (source)

Undocumented

@property
cube: list[str] | None = (source)

Undocumented

@property
image: str | None = (source)

Undocumented

@property
intensity: float | None = (source)

Undocumented

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

Undocumented

_color = (source)

Undocumented

_cube = (source)

Undocumented

_image = (source)

Undocumented

_intensity = (source)

Undocumented