Trace::Params class reference
[Core module]

This class is a member of the Trace namespace.

This class is used to store light progation parameters. This includes sequential / non-sequential mode, light intensity computation mode and propagation mode (raytracing, diffraction, ...).

See also Performing light propagation section.

See also the full member list section for this class.

• Params ()
• const Distribution & get_default_distribution () const
• Distribution & get_default_distribution ()
• const Distribution & get_distribution (const Sys::Surface &s) const
• IntensityMode get_intensity_mode () const
• double get_lost_ray_length () const
• unsigned int get_max_bounce () const
• bool get_unobstructed () const
• bool is_sequential () const
• void reset_distribution ()
• void set_default_distribution (const Distribution &default_distribution)
• void set_distribution (const Sys::Surface &s, const Distribution &dist)
• void set_intensity_mode (IntensityMode intensity_mode)
• void set_lost_ray_length (double lost_ray_length)
• void set_max_bounce (unsigned int max_bounce)
• void set_nonsequential_mode ()
• void set_sequential_mode (const const_ref<Sequence> &seq)
• void set_unobstructed (bool unobstructed)

Params()

No documentation available

const Distribution & get_default_distribution() const

Get default rays distribution pattern.

See also set_default_distribution function.

Distribution & get_default_distribution()

Get default rays distribution pattern.

See also set_default_distribution function.

const Distribution & get_distribution(const Sys::Surface &s) const

Get distribution pattern for a given surface

IntensityMode get_intensity_mode() const

Get raytracing intensity mode.

See also set_intensity_mode function.

double get_lost_ray_length() const

Get lost ray length.

See also set_lost_ray_length function.

unsigned int get_max_bounce() const

Get maximum ray bounce count, default is 50.

See also set_max_bounce function.

bool get_unobstructed() const

Get unobstructed raytracing mode. Surface shapes are ignored, no rays are stopped.

See also set_unobstructed function.

bool is_sequential() const

Test if in sequential ray tracing mode

void reset_distribution()

Reset all surface specific distribution settings to default

void set_default_distribution(const Distribution &default_distribution)

Set default rays distribution pattern.

See also get_default_distribution function.

void set_distribution(const Sys::Surface &s, const Distribution &dist)

Set distribution pattern for a given surface

void set_intensity_mode(IntensityMode intensity_mode)

Set raytracing intensity mode.

See also get_intensity_mode function.

void set_lost_ray_length(double lost_ray_length)

Set lost ray length.

See also get_lost_ray_length function.

void set_max_bounce(unsigned int max_bounce)

Set maximum ray bounce count, default is 50.

See also get_max_bounce function.

void set_nonsequential_mode()

Set non sequential ray tracing mode (default)

void set_sequential_mode(const const_ref <Sequence> &seq)

Set sequential ray tracing mode

void set_unobstructed(bool unobstructed)

Set unobstructed raytracing mode. Surface shapes are ignored, no rays are stopped.

See also get_unobstructed function.