report.Camera

class Camera

Bases: Flow360BaseModel

Represents the camera configuration payload.

Attributes

position: tuple[float, float, float], optional

Camera eye position, think of the eye position as a position on the unit sphere centered at the lookAt. The units are in length units used in geometry or volume mesh.

Default:

(-1, -1, 1)

up: tuple[float, float, float], optional

Up orientation of the camera.

Default:

(0, 0, 1)

look_at: tuple[float, float, float], optional

Target point the camera will look at from the position. Default: center of bbox. The units are in length units used in geometry or volume mesh.

Default:

None

pan_target: tuple[float, float, float], optional

Position to pan the viewport center to; if undefined, the default is look_at. The units are in length units used in geometry or volume mesh.

Default:

None

dimension_dir: Literal['width', 'height', 'diagonal'], optional

The direction dimension_size_model_units is for.

Default:

'width'

dimension: float, optional

The camera zoom will be set such that the extents of the scene’s projection is this number of model units for the applicable dimension_dir. The units are in length units used in geometry or volume mesh.

Default:

None

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')