Skip to main content

AVxcelerate Asset Preparation API 2024 R2

asset_preparation::v3::surface_source::SurfaceSourceProperties Struct Reference

Last update: 16.07.2025

The properties of a surface source. More...

Collaboration diagram for asset_preparation::v3::surface_source::SurfaceSourceProperties:

Public Attributes

google::protobuf::DoubleValue flux = 1
 
google::protobuf::DoubleValue angular_precision = 2
 
LambertianDiagram lambertian = 3
 
LibraryDiagram diagram_library = 4
 
GaussianDiagram gaussian = 5
 
google::protobuf::BoolValue reverse_direction = 6
 
common::Empty no_contribution = 7
 
LightingContribution lighting_contribution = 8
 
SpectrumLibrary spectrum_library = 9
 
BlackBody black_body = 10
 
Monochromatic monochromatic = 11
 

Detailed Description

The properties of a surface source.

Member Data Documentation

◆ flux

google::protobuf::DoubleValue asset_preparation::v3::surface_source::SurfaceSourceProperties::flux = 1

The surface source flux.

Unit: lumen (lm)

Note
Must be positive.
The default value is 500.

◆ angular_precision

google::protobuf::DoubleValue asset_preparation::v3::surface_source::SurfaceSourceProperties::angular_precision = 2

The angular precision.

Unit: Degree

Note
Must be positive.
The default value is 0.

◆ lambertian

LambertianDiagram asset_preparation::v3::surface_source::SurfaceSourceProperties::lambertian = 3

ONEOF(angular_diagram) Intensity based on a lambertian angular diagram.

◆ diagram_library

LibraryDiagram asset_preparation::v3::surface_source::SurfaceSourceProperties::diagram_library = 4

ONEOF(angular_diagram) Intensity based on a library angular diagram.

Note
This is the default type of angular diagram.

◆ gaussian

GaussianDiagram asset_preparation::v3::surface_source::SurfaceSourceProperties::gaussian = 5

ONEOF(angular_diagram) Intensity based on a gaussian angular diagram.

◆ reverse_direction

google::protobuf::BoolValue asset_preparation::v3::surface_source::SurfaceSourceProperties::reverse_direction = 6

Whether the direction of the surface source is reversed.

◆ no_contribution

common::Empty asset_preparation::v3::surface_source::SurfaceSourceProperties::no_contribution = 7

ONEOF(contribution) The surface source does not contribute to lighting.

Note
This is the default value.

◆ lighting_contribution

LightingContribution asset_preparation::v3::surface_source::SurfaceSourceProperties::lighting_contribution = 8

ONEOF(contribution) The lighting contribution of the surface source.

◆ spectrum_library

SpectrumLibrary asset_preparation::v3::surface_source::SurfaceSourceProperties::spectrum_library = 9

ONEOF(spectrum) Spectrum based on a spectrum file.

Note
This is the default spectrum type.

◆ black_body

BlackBody asset_preparation::v3::surface_source::SurfaceSourceProperties::black_body = 10

ONEOF(spectrum) Spectrum based on a black body.

◆ monochromatic

Monochromatic asset_preparation::v3::surface_source::SurfaceSourceProperties::monochromatic = 11

ONEOF(spectrum) Monochromatic spectrum.


The documentation for this struct was generated from the following file:
  • surface_source_description.proto

Connect with Ansys