UE3:MaterialInterface (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
UDK Object >> Surface >> MaterialInterface
Package:
Engine
Direct subclasses:
Material, MaterialInstance
This class in other games:


Properties

Property group 'Lightmass'

LightmassSettings

Type: LightmassMaterialInterfaceSettings

Modifiers: protected

The Lightmass settings for this object.

Default value:

Member Value
DiffuseBoost 1.0
EmissiveBoost 1.0
ExportResolutionScale 1.0
SpecularBoost 1.0

Property group 'MaterialInterface'

PreviewMesh

Type: string

Modifiers: editoronly

The mesh used by the material editor to preview the material.

Internal variables

LightingGuid

Type: Object.Guid

Modifiers: private, const

Unique ID for this material, used for caching during distributed lighting

ParentRefFence

Type: Object.RenderCommandFence_Mirror{FRenderCommandFence}

Modifiers: native, const, transient

A fence to track when the primitive is no longer used as a parent

Enums

EMaterialUsage

MATUSAGE_SkeletalMesh
MATUSAGE_FracturedMeshes
MATUSAGE_ParticleSprites
MATUSAGE_BeamTrails
MATUSAGE_ParticleSubUV
MATUSAGE_Foliage
MATUSAGE_SpeedTree
MATUSAGE_StaticLighting
MATUSAGE_GammaCorrection
MATUSAGE_LensFlare
MATUSAGE_InstancedMeshParticles
MATUSAGE_FluidSurface
MATUSAGE_Decals
MATUSAGE_MaterialEffect
MATUSAGE_MorphTargets
MATUSAGE_FogVolumes
MATUSAGE_RadialBlur
MATUSAGE_InstancedMeshes
MATUSAGE_SplineMesh

Structs

LightmassMaterialInterfaceSettings

Modifiers: native

Material interface settings for Lightmass

float EmissiveBoost
Scales the emissive contribution of this material to static lighting.
float DiffuseBoost
Scales the diffuse contribution of this material to static lighting.
float SpecularBoost
Scales the specular contribution of this material to static lighting.
float ExportResolutionScale
Scales the resolution that this material's attributes were exported at.

This is useful for increasing material resolution when details are needed.

bool bOverrideEmissiveBoost
If TRUE, override the emissive boost setting of the parent material.
bool bOverrideDiffuseBoost
If TRUE, override the diffuse boost setting of the parent material.
bool bOverrideSpecularBoost
If TRUE, override the specular boost setting of the parent material.
bool bOverrideExportResolutionScale
If TRUE, override the export resolution scale setting of the parent material.

Default values:

Property Value
DiffuseBoost 1.0
EmissiveBoost 1.0
ExportResolutionScale 1.0
SpecularBoost 1.0

Native functions

GetFontParameterValue

native function bool GetFontParameterValue (name ParameterName, out Font OutFontValue, out int OutFontPage)


GetMaterial

native final noexport function Material GetMaterial ()


GetPhysicalMaterial

native final noexport function PhysicalMaterial GetPhysicalMaterial () const

Returns a pointer to the physical material used by this material instance.

Returns:

The physical material.

GetScalarCurveParameterValue

native function bool GetScalarCurveParameterValue (name ParameterName, out Object.InterpCurveFloat OutValue)


GetScalarParameterValue

native function bool GetScalarParameterValue (name ParameterName, out float OutValue)


GetTextureParameterValue

native function bool GetTextureParameterValue (name ParameterName, out Texture OutValue)


GetVectorCurveParameterValue

native function bool GetVectorCurveParameterValue (name ParameterName, out Object.InterpCurveVector OutValue)


GetVectorParameterValue

native function bool GetVectorParameterValue (name ParameterName, out Object.LinearColor OutValue)


SetForceMipLevelsToBeResident

native function SetForceMipLevelsToBeResident (bool OverrideForceMiplevelsToBeResident, bool bForceMiplevelsToBeResidentValue, float ForceDuration)

Forces the streaming system to disregard the normal logic for the specified duration and instead always load all mip-levels for all textures used by this material.

Parameters:

  • ForceDuration - Number of seconds to keep all mip-levels in memory, disregarding the normal priority logic.