maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL Namespace Reference

Detailed Description

This is a simple material description to offer viewport and export support for node materials.

Functions

 MAXON_RESOURCE_DATABASE_SCOPE ("net.maxon.nodespace.exchange.bundle.viewportmaterial")
 
 MAXON_ATTRIBUTE (InternedId, TYPE, "type")
 
 MAXON_ATTRIBUTE (void, TYPE_ENUM_CONSTANT, "constant")
 
 MAXON_ATTRIBUTE (void, TYPE_ENUM_METAL, "metal")
 
 MAXON_ATTRIBUTE (void, TYPE_ENUM_DIELECTRIC, "dielectric")
 
 MAXON_ATTRIBUTE (void, TYPE_ENUM_VOLUMETRIC, "volumetric")
 
 MAXON_ATTRIBUTE (Float, TRANSMISSIVITY, "transmissivity ")
 
 MAXON_ATTRIBUTE (Float, ALPHA, "alpha")
 
 MAXON_ATTRIBUTE (Color, BASE_COLOR, "base.color")
 
 MAXON_ATTRIBUTE (Float, BASE_COLOR_WEIGHT, "base.color_weight")
 
 MAXON_ATTRIBUTE (Vector, BASE_NORMAL, "base.normal")
 
 MAXON_ATTRIBUTE (Float, BASE_NORMAL_WEIGHT, "base.normal_weight")
 
 MAXON_ATTRIBUTE (Color, SPECULAR_COLOR, "specular.color")
 
 MAXON_ATTRIBUTE (Float, SPECULAR_COLOR_WEIGHT, "specular.color_weight")
 
 MAXON_ATTRIBUTE (Vector, SPECULAR_NORMAL, "specular.normal")
 
 MAXON_ATTRIBUTE (Float, SPECULAR_NORMAL_WEIGHT, "specular.normal_weight")
 
 MAXON_ATTRIBUTE (Float, SPECULAR_ROUGHNESS, "specular.roughness")
 
 MAXON_ATTRIBUTE (Float, SPECULAR_IOR, "specular.ior")
 
 MAXON_ATTRIBUTE (Color, EMISSION_COLOR, "emission.color")
 
 MAXON_ATTRIBUTE (Float, EMISSION_COLOR_WEIGHT, "emission.color_weight")
 
 MAXON_ATTRIBUTE (Float, SCATTERING_COEFFICIENT, "scattering.coefficient")
 
 MAXON_ATTRIBUTE (Float, ABSORPTION_COEFFICIENT, "absorption.coefficient")
 
 MAXON_ATTRIBUTE (Float, EMISSION_COEFFICIENT, "emission.coefficient")
 
 MAXON_ATTRIBUTE (Float, EMISSION_TEMPERATURE, "emission.temperature")
 
 MAXON_ATTRIBUTE (Gradient, SCATTERING_GRADIENT, "scattering.gradient")
 
 MAXON_ATTRIBUTE (Gradient, ABSORPTION_GRADIENT, "absorption.gradient")
 
 MAXON_ATTRIBUTE (InternedId, EMISSION_TYPE, "emission.type")
 
 MAXON_ATTRIBUTE (void, EMISSION_TYPE_ENUM_NONE, "none")
 
 MAXON_ATTRIBUTE (void, EMISSION_TYPE_ENUM_RAMP, "ramp")
 
 MAXON_ATTRIBUTE (void, EMISSION_TYPE_ENUM_BLACKBODY, "blackbody")
 
 MAXON_ATTRIBUTE (Gradient, EMISSION_GRADIENT, "emission.gradient")
 
 MAXON_ATTRIBUTE (Float, DENSITY_SHADOW_SCALE, "density.shadow_scale")
 
 MAXON_ATTRIBUTE (Range< Float >, DENSITY_RANGE_OLD, "density.range_old")
 
 MAXON_ATTRIBUTE (Range< Float >, DENSITY_RANGE_NEW, "density.range_new")
 
 MAXON_ATTRIBUTE (Range< Float >, EMISSION_RANGE_OLD, "emission.range_old")
 
 MAXON_ATTRIBUTE (Range< Float >, EMISSION_RANGE_NEW, "emission.range_new")
 
 MAXON_ATTRIBUTE (Group, GROUP_GENERAL, "group.general")
 
 MAXON_ATTRIBUTE (Group, GROUP_BASE, "group.base")
 
 MAXON_ATTRIBUTE (Group, GROUP_SPECULAR, "group.specular")
 
 MAXON_ATTRIBUTE (Group, GROUP_EMISSION, "group.emission")
 
 MAXON_ATTRIBUTE (Group, GROUP_VOLUME, "group.volume")
 

Function Documentation

◆ MAXON_RESOURCE_DATABASE_SCOPE()

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_RESOURCE_DATABASE_SCOPE ( "net.maxon.nodespace.exchange.bundle.viewportmaterial"  )

◆ MAXON_ATTRIBUTE() [1/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( InternedId  ,
TYPE  ,
"type"   
)

Defines the type of material in the viewport:

  • Constant: a dielectric material with specular layer on top and diffuse base.
  • Metal: a metal / conductor with GGX layer.
  • Dielectric: a dielectric material with specular layer on top and diffuse base. Note that we do not support dynamic metalness.

◆ MAXON_ATTRIBUTE() [2/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( void  ,
TYPE_ENUM_CONSTANT  ,
"constant"   
)

◆ MAXON_ATTRIBUTE() [3/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( void  ,
TYPE_ENUM_METAL  ,
"metal"   
)

◆ MAXON_ATTRIBUTE() [4/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( void  ,
TYPE_ENUM_DIELECTRIC  ,
"dielectric"   
)

◆ MAXON_ATTRIBUTE() [5/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( void  ,
TYPE_ENUM_VOLUMETRIC  ,
"volumetric"   
)

◆ MAXON_ATTRIBUTE() [6/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Float  ,
TRANSMISSIVITY  ,
"transmissivity "   
)

Defines the transparency of dielectric materials in the range [0.0, 1.0] from not transparent to fully transparent.

◆ MAXON_ATTRIBUTE() [7/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Float  ,
ALPHA  ,
"alpha"   
)

Defines the alpha of the material in the range [0.0, 1.0] from invisible to opaque.

◆ MAXON_ATTRIBUTE() [8/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Color  ,
BASE_COLOR  ,
"base.color"   
)

◆ MAXON_ATTRIBUTE() [9/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Float  ,
BASE_COLOR_WEIGHT  ,
"base.color_weight"   
)

◆ MAXON_ATTRIBUTE() [10/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Vector  ,
BASE_NORMAL  ,
"base.normal"   
)

Data is expected to be in [0,1] range with the geometric normal = [0.5, 0.5, 1.0]. The tangent frame is oriented in accordance with OpenGL and Unity.

◆ MAXON_ATTRIBUTE() [11/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Float  ,
BASE_NORMAL_WEIGHT  ,
"base.normal_weight"   
)

◆ MAXON_ATTRIBUTE() [12/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Color  ,
SPECULAR_COLOR  ,
"specular.color"   
)

◆ MAXON_ATTRIBUTE() [13/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Float  ,
SPECULAR_COLOR_WEIGHT  ,
"specular.color_weight"   
)

◆ MAXON_ATTRIBUTE() [14/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Vector  ,
SPECULAR_NORMAL  ,
"specular.normal"   
)

Data is expected to be in [0,1] range with the geometric normal = [0.5, 0.5, 1.0]. The tangent frame is oriented in accordance with OpenGL and Unity.

◆ MAXON_ATTRIBUTE() [15/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Float  ,
SPECULAR_NORMAL_WEIGHT  ,
"specular.normal_weight"   
)

◆ MAXON_ATTRIBUTE() [16/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Float  ,
SPECULAR_ROUGHNESS  ,
"specular.roughness"   
)

◆ MAXON_ATTRIBUTE() [17/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Float  ,
SPECULAR_IOR  ,
"specular.ior"   
)

◆ MAXON_ATTRIBUTE() [18/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Color  ,
EMISSION_COLOR  ,
"emission.color"   
)

◆ MAXON_ATTRIBUTE() [19/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Float  ,
EMISSION_COLOR_WEIGHT  ,
"emission.color_weight"   
)

◆ MAXON_ATTRIBUTE() [20/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Float  ,
SCATTERING_COEFFICIENT  ,
"scattering.coefficient"   
)

◆ MAXON_ATTRIBUTE() [21/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Float  ,
ABSORPTION_COEFFICIENT  ,
"absorption.coefficient"   
)

◆ MAXON_ATTRIBUTE() [22/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Float  ,
EMISSION_COEFFICIENT  ,
"emission.coefficient"   
)

◆ MAXON_ATTRIBUTE() [23/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Float  ,
EMISSION_TEMPERATURE  ,
"emission.temperature"   
)

◆ MAXON_ATTRIBUTE() [24/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Gradient  ,
SCATTERING_GRADIENT  ,
"scattering.gradient"   
)

◆ MAXON_ATTRIBUTE() [25/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Gradient  ,
ABSORPTION_GRADIENT  ,
"absorption.gradient"   
)

◆ MAXON_ATTRIBUTE() [26/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( InternedId  ,
EMISSION_TYPE  ,
"emission.type"   
)

Defines the type of volume emission in the viewport:

  • None: default - no emission
  • Ramp: requires an emission gradient
  • Blackbody: uses the temperature for blackbody radiation

◆ MAXON_ATTRIBUTE() [27/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( void  ,
EMISSION_TYPE_ENUM_NONE  ,
"none"   
)

◆ MAXON_ATTRIBUTE() [28/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( void  ,
EMISSION_TYPE_ENUM_RAMP  ,
"ramp"   
)

◆ MAXON_ATTRIBUTE() [29/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( void  ,
EMISSION_TYPE_ENUM_BLACKBODY  ,
"blackbody"   
)

◆ MAXON_ATTRIBUTE() [30/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Gradient  ,
EMISSION_GRADIENT  ,
"emission.gradient"   
)

◆ MAXON_ATTRIBUTE() [31/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Float  ,
DENSITY_SHADOW_SCALE  ,
"density.shadow_scale"   
)

◆ MAXON_ATTRIBUTE() [32/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Range< Float ,
DENSITY_RANGE_OLD  ,
"density.range_old"   
)

◆ MAXON_ATTRIBUTE() [33/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Range< Float ,
DENSITY_RANGE_NEW  ,
"density.range_new"   
)

◆ MAXON_ATTRIBUTE() [34/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Range< Float ,
EMISSION_RANGE_OLD  ,
"emission.range_old"   
)

◆ MAXON_ATTRIBUTE() [35/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Range< Float ,
EMISSION_RANGE_NEW  ,
"emission.range_new"   
)

◆ MAXON_ATTRIBUTE() [36/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Group  ,
GROUP_GENERAL  ,
"group.general"   
)

◆ MAXON_ATTRIBUTE() [37/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Group  ,
GROUP_BASE  ,
"group.base"   
)

◆ MAXON_ATTRIBUTE() [38/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Group  ,
GROUP_SPECULAR  ,
"group.specular"   
)

◆ MAXON_ATTRIBUTE() [39/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Group  ,
GROUP_EMISSION  ,
"group.emission"   
)

◆ MAXON_ATTRIBUTE() [40/40]

maxon::NODESPACE::EXCHANGE::BUNDLE::VIEWPORTMATERIAL::MAXON_ATTRIBUTE ( Group  ,
GROUP_VOLUME  ,
"group.volume"   
)