Core API Classes

The core API classes are used as parameter for some functions (such as set_renderer_params or set_camera_params).


FisheyeCameraParams

Sets the parameters of the fish-eye like camera. Used after calling set_camera with type="fisheye", by calling set_camera_params.

Member variables:

  • aperture_radius: Float, Lens aperture radius. Controls depth of field.

  • aspect: Float, Generated image aspect ratio, calculated as image width / image height.

  • enable_clipping_planes: `Bool, Wether to enable geometry clipping from any loaded clipping plane.

  • focus_distance: Float, Controls de focus distance for depth of field.

  • fovy: Float, vertical field of view.


PerspectiveCameraParams

Sets the parameters of the perspective camera. Used after calling set_camera with type="perspective", by calling set_camera_params

Member variables:

  • aperture_radius: Float, Lens aperture radius. Controls depth of field.

  • aspect: Float, Generated image aspect ratio, calculated as image width / image height.

  • enable_clipping_planes: Bool, Wether to enable geometry clipping from any loaded clipping plane.

  • focus_distance: Float, Controls de focus distance for depth of field.

  • fovy: Float, vertical field of view.


PerspectiveparallaxCameraParams

Sets the parameters of the perspective parallax camera. This camera is mainly used on a virtual environment, such as the OpenDeck, for stereo rendering. Used after calling set_camera with type="perspectiveParallax", by calling set_camera_params.

Member variables:

  • aspect: Float, Generated image aspect ratio, calculated as image width / image height.

  • enable_clipping_planes: Bool, Wether to enable geometry clipping from any loaded clipping plane.

  • fovy: Float, vertical field of view.


OrthographicCameraParams

Sets the parameters of the ortographic (parallel projection) camera. Used after calling set_camera with type="ortographic", by calling set_camera_params

Member variables:

  • aspect: Float, Generated image aspect ratio, calculated as image width / image height.

  • enable_clipping_planes: Bool, Wether to enable geometry clipping from any loaded clipping plane.

  • height: Float, Height of the projection plane. The width is calculated as height x aspect.


PanoramicCameraParams

Sets the parameters of the panoramic (High field of view) camera. Used after calling set_camera with type="panoramic", by calling set_camera_params

Member variables:

  • enable_clipping_planes: Bool, Wether to enable geometry clipping from any loaded clipping plane.

  • half: Bool, Wether to capture half a sphere or the full sphere around the camera.


BasicRendererParams

Sets the parameters of the basic renderer. Used after calling set_renderer with current="basic", by calling set_renderer_params.

This renderer has no parameters to be configured.


PathtracerRendererParams

Sets the parameters of the path tracer (photorealistic) renderer. Used after calling set_renderer with current="pathtracer", by calling set_renderer_params.

Member variables:

  • max_contribution: Float, Max contribution of each ray to the final image integration.

  • roulette_depth: Integer, Ray depth at which to start using Russian Roulette to discard rays.


RaycastNgRendererParams

Sets the parameters of the raycast Ng renderer (Displays geometry normal at ray intersection point). Used after calling set_renderer with current="raycast_Ng", by calling set_renderer_params.

This renderer has no parameters to be configured.


RaycastNsRendererParams

Sets the parameters of the raycast Ns renderer (Displays shading smooth normal at ray intersection point). Used after calling set_renderer with current="raycast_Ns", by calling set_renderer_params.

This renderer has no parameters to be configured.


ScivisRendererParams

Sets the parameters of the scientific visualization renderer. Used after calling set_renderer with current="scivis", by calling set_renderer_params.

Member variables:

  • ao_distance: Float, Max distance at which keep computing the ambient occlussion.

  • ao_samples: Integer, Number of samples to use when computing the ambient occlussion.

  • ao_transparency_enabled: Bool, Wether to compute ambient occlussion for transparent objects

  • ao_weight: Float, Ambient occlussion weight when computing final shading.

  • one_sided_lighting: Bool, Wether to shade geometry facing the camera, or also geometry facing away.

  • shadows_enabled: Bool, Wether to enable casted shadows when rendering.