Skip to main content

AVxcelerate Asset Preparation API 2024 R2

asset_preparation::v3::surface_source Namespace Reference

Last update: 16.07.2025

Classes

struct  BlackBody
 Spectrum based on a black body. More...
 
struct  CreateSurfaceSourceRequest
 The information required to create a surface source. More...
 
struct  CreateSurfaceSourceResponse
 The identity of the created surface source. More...
 
struct  CreateSurfaceSourceStateRequest
 The information required to create a surface source state. More...
 
struct  CreateSurfaceSourceStateResponse
 The response returned when creating a surface source state. More...
 
struct  DeleteSurfaceSourceRequest
 The information required to delete a surface source. More...
 
struct  DeleteSurfaceSourceResponse
 The response returned when deleting a surface source. More...
 
struct  DeleteSurfaceSourceStateRequest
 The information required to delete a surface source state. More...
 
struct  DeleteSurfaceSourceStateResponse
 The response returned when deleting a surface source state. More...
 
struct  DisplaySourceProperties
 The properties of a display source. More...
 
struct  GaussianDiagram
 The properties of gaussian angular diagram. More...
 
struct  GetSurfaceSourceRequest
 The information required to examine a surface source. More...
 
struct  GetSurfaceSourceResponse
 The properties of a surface source. More...
 
struct  GetSurfaceSourceStateRequest
 The information required to examine a state. More...
 
struct  GetSurfaceSourceStateResponse
 The information about a surface source state. More...
 
struct  LambertianDiagram
 Lambertian angular diagram. More...
 
struct  LibraryDiagram
 The properties of library angular diagram. More...
 
struct  LightingContribution
 Describes how a surface or display source contributes to the scene lighting, including whether the different surfaces composing the geometry must be joint or disjoint. More...
 
struct  ListSurfaceSourcesResponse
 The identities of all surface sources in the collection. More...
 
struct  Monochromatic
 Monochromatic spectrum. More...
 
struct  Rendering
 The rendering properties. More...
 
struct  Shadows
 The properties of shadows. More...
 
struct  SourceProperties
 The source properties. More...
 
struct  SpectrumLibrary
 Spectrum based on a spectrum file. More...
 
struct  SurfaceSourceIdentity
 The full identity of a surface source, consisting of an identifier and a name. More...
 
class  SurfaceSourcePreparation
 Surface Source Preparation Service. More...
 
struct  SurfaceSourceProperties
 The properties of a surface source. More...
 
struct  UpdateSurfaceSourceRequest
 The information required to update a surface source. More...
 
struct  UpdateSurfaceSourceResponse
 The response returned when updating a surface source. More...
 
struct  UpdateSurfaceSourceStateRequest
 The information required to update a surface source state. More...
 
struct  UpdateSurfaceSourceStateResponse
 The response returned when updating a surface source state. More...
 
struct  Vector3
 Vector in a 3D referential. More...
 

Enumerations

enum  DisjointFluxDistributionType { DISTRIBUTION_TYPE_UNSPECIFIED = 0, DISTRIBUTION_TYPE_PROPORTIONAL = 1, DISTRIBUTION_TYPE_EVEN = 2 }
 The type of disjoint flux distribution. More...
 

Variables

import google protobuf empty proto
 

Enumeration Type Documentation

◆ DisjointFluxDistributionType

The type of disjoint flux distribution.

Enumerator
DISTRIBUTION_TYPE_UNSPECIFIED 

Unspecified disjoint flux distribution type.

DISTRIBUTION_TYPE_PROPORTIONAL 

Flux distributed proportionally to the area of each disjoint surface.

Note
With this distribution type, the power emitted by one disjoint surface is equal to the power defined in the surface source properties multiplied by the ratio of area of the disjoint surface to the total area.
DISTRIBUTION_TYPE_EVEN 

Flux distributed evenly among the disjoint surfaces.

Note
With this distribution type, each disjoint surface emits the same power. The power of each disjoint surface is equal to the power defined in the surface source properties divided by the number of surfaces.

Variable Documentation

◆ proto

import google protobuf wrappers asset_preparation::v3::surface_source::proto

Connect with Ansys