Camera

Camera#

class Camera[source]#

Bases: Flow360BaseModel

Camera configures the camera and projection used for rendering.

Example

>>> Camera.perspective(
...     x=1, y=1, z=1, scale=2, view=Viewpoint.FRONT
... )

Attributes

projection: OrthographicProjection | PerspectiveProjection#: Projection settings (FOV / width, near/far clipping planes)

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

classmethod orthographic(position=(0, 0, 0), scale=1, view=None)[source]#

Create an orthographic camera configuration.

Example

>>> Camera.orthographic(
...     position=(0, 0, 0), scale=1.5, view=Viewpoint.TOP
... )

classmethod perspective(position=(0, 0, 0), scale=1, view=None)[source]#

Create a perspective camera configuration.

Example

>>> Camera.perspective(
...     position=(0, 0, 0), scale=3, view=Viewpoint.LEFT
... )

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') 