This is the documentation for Enlighten.
class Enlighten PipelineRadiosityInstance
- geosw (Unlicensed)
class Enlighten::PipelineRadiosityInstance
└>Enlighten::PipelineRadiosityProperties
An instance object, corresponding to an <instance> element in the .scene file.
Typedefs
| Name | Description |
|---|---|
| PipelineInstanceMaterial MaterialOverride | Overrides the nth material of each mesh with the geometry object. |
| Geo::GeoArray< MaterialOverride > MaterialOverrides | An array of MaterialOverride instances. |
Variables
| Name | Description |
|---|---|
| Geo::GeoFileString m_BakeLightmapName | Used only for baked lighting. Specify the name of the atlas into which the baked lightmap for this instance is packed. |
| Geo::GeoFileString m_BakeLightmapType | Used only for baked lighting. Specify the parameters of the baked lightmap for this instance. |
| Geo::GeoFileString m_Geom | The key of the geom this instance references. |
| Geo::GeoFileString m_Group | (optional) The name of the group the instance is associated with. Prevents automatic grouping of this instance. |
| const PipelineRadiosityGroupType m_GroupType | Whether the instance group can be automatically split by the precompute. |
| Geo::GeoGuid m_Guid | The globally unique identifier of this instance. |
| PipelineRadiosityLightingType m_Lighting | The way an instance receives Enlighten lighting output. |
| MaterialOverrides m_Materials | Overrides the materials specified in the geom. |
| Geo::GeoFileString m_Name | The name of this instance. |
| Geo::GeoFileString m_Paramset | The name of the paramset the instance refers to, found within the .paramset file. |
| Geo::GeoFileString m_ProbeParamset | The optional name of the probe parameter set associated with the probes placed for this instance. |
| ProbeOctreeResolution m_ProbeResolution | The resolution at which probes are placed to provide lighting for this instance. |
| PipelineRadiosityShadowType m_Shadow | Whether this instance casts an indirect shadow. |
| PipelineTransform m_Transform | The local to world transform. |
| Geo::GeoFileString m_Zone | The name of the zone the instance is associated with. |
Functions
| Name | Description |
|---|---|
| LightmapRadiosity() | An instance with these properties is included in the radiosity computation and lit using a lightmap. |
| PipelineRadiosityInstance(Geo::GeoFileString, Geo::GeoFileString, PipelineRadiosityProperties, Geo::GeoFileString, Geo::GeoFileString, PipelineTransform, MaterialOverrides) | Constructor. |
| PipelineRadiosityInstance(Geo::GeoFileString, Geo::GeoFileString, PipelineRadiosityProperties, PipelineRadiosityGroupType, Geo::GeoFileString, Geo::GeoFileString, PipelineTransform, MaterialOverrides) | Constructor. |
| PipelineRadiosityProperties(PipelineRadiosityLightingType, PipelineRadiosityShadowType) | Constructor. |
| ProbeRadiosity() | An instance with these properties is included in the radiosity computation and lit using probes. |
static PipelineRadiosityProperties Enlighten::PipelineRadiosityProperties::LightmapRadiosity
public: PipelineRadiosityProperties LightmapRadiosity()
An instance with these properties is included in the radiosity computation and lit using a lightmap.
Enlighten::PipelineRadiosityInstance::PipelineRadiosityInstance
public: PipelineRadiosityInstance
(
Geo::GeoFileString name,
Geo::GeoFileString geom,
PipelineRadiosityProperties properties,
Geo::GeoFileString zone,
Geo::GeoFileString paramset,
PipelineTransform transform,
MaterialOverrides materials
)
Constructor.
Enlighten::PipelineRadiosityInstance::PipelineRadiosityInstance
public: PipelineRadiosityInstance
(
Geo::GeoFileString name,
Geo::GeoFileString geom,
PipelineRadiosityProperties properties,
PipelineRadiosityGroupType groupType,
Geo::GeoFileString group,
Geo::GeoFileString paramset,
PipelineTransform transform,
MaterialOverrides materials
)
Constructor.
Enlighten::PipelineRadiosityProperties::PipelineRadiosityProperties
public: PipelineRadiosityProperties
(
PipelineRadiosityLightingType lighting,
PipelineRadiosityShadowType shadow
)
Constructor.
static PipelineRadiosityProperties Enlighten::PipelineRadiosityProperties::ProbeRadiosity
public: PipelineRadiosityProperties ProbeRadiosity()
An instance with these properties is included in the radiosity computation and lit using probes.