Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.FogVolumeDensityComponent


00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00041
00042
00043
00044
00045
00046
00047
00048
00049
00050
00051
00052
00053
00054
00055
00056
00057
00058
00059
00060
00061
00062
00063
00064
00065
00066
00067
00068
00069
00070
00071
00072
00073
00074
00075
00076
00077
00078
00079
00080
00081
00082
00083
00084
00085
00086
00087
00088
00089
00090
00091
00092
00093
00094
00095
00096
00097
00098
00099
00100
00101
00102
00103
00104
/**
 * Copyright 1998-2011 Epic Games, Inc. All Rights Reserved.
 */
class FogVolumeDensityComponent extends ActorComponent
	native(FogVolume)
	hidecategories(Object)
	abstract
	editinlinenew;

/** Fog Material to use on the AutomaticComponent.  This will not be used on FogVolumeActors, they will use their existing materials. */
var() MaterialInterface FogMaterial;

var MaterialInterface DefaultFogVolumeMaterial;

/** True if the fog is enabled. */
var()	const	bool	bEnabled;

/** 
 * Controls whether the fog volume affects intersecting translucency.  
 * If FALSE, the fog volume will sort normally with translucency and not fog intersecting translucent objects.
 */
var()   bool	bAffectsTranslucency;

/** 
 * Controls whether the fog volume affects opaque pixels, or just intersecting translucency.  
 */
var()   bool	bOnlyAffectsTranslucency;

/** 
 * Sets the 'EmissiveColor' Vector Parameter of FogMaterial.
 * This will have no effect if FogMaterial has been overridden with a material that does not have a 'EmissiveColor' parameter.  
 */
var()	interp	LinearColor	SimpleLightColor;

/** 
 * Color used to approximate fog material color on transparency. 
 * Important: Set this color to match the overall color of the fog material, otherwise transparency will not be fogged correctly.
 */
var()	interp	LinearColor	ApproxFogLightColor;

/** Distance from the camera that the fog should start, in world units. */
var()	interp	float	StartDistance;

/** 
 * Optional array of actors that will define the shape of the fog volume. 
 * These actors will not be moved along with the fog volume, and they can be selected directly.
 */
var()	array<Actor>	FogVolumeActors;

cpptext
{
private:
	/** Adds the fog volume components to the scene */
	void AddFogVolumeComponents();

	/** Removes the fog volume components from the scene */
	void RemoveFogVolumeComponents();

	/** 
	 * Sets up FogVolumeActors's mesh components to defaults that are common usage with fog volumes.  
	 * Collision is disabled for the actor, each component gets assigned the default fog volume material,
	 * lighting, shadowing, decal accepting, and occluding are disabled.
	 */
	void SetFogActorDefaults(const INT FogActorIndex);

protected:
	// ActorComponent interface.
	virtual void Attach();
	virtual void UpdateTransform();
	virtual void Detach( UBOOL bWillReattach = FALSE );

	// UObject interface
	virtual void PostEditChangeChainProperty(FPropertyChangedChainEvent& PropertyChangedEvent);

public:
	// FogVolumeDensityComponent interface.
	virtual class FFogVolumeDensitySceneInfo* CreateFogVolumeDensityInfo(const UPrimitiveComponent* MeshComponent) const PURE_VIRTUAL(UFogVolumeDensityComponent::CreateFogVolumeDensityInfo,return NULL;);

	/** Checks for partial fog volume setup that will not render anything. */
#if WITH_EDITOR
	virtual void CheckForErrors();
#endif

	/** Returns FogMaterial if it is valid, otherwise DefaultFogVolumeMaterial */
	UMaterialInterface*	GetMaterial() const;
}

/**
 * Changes the enabled state of the height fog component.
 * @param bSetEnabled - The new value for bEnabled.
 */
final native function SetEnabled(bool bSetEnabled);

defaultproperties
{
	DefaultFogVolumeMaterial=Material'EngineMaterials.FogVolumeMaterial'
	bEnabled=TRUE
	bAffectsTranslucency=TRUE
	bOnlyAffectsTranslucency=FALSE
	SimpleLightColor=(R=0.5,G=0.5,B=0.7,A=1.0)
	ApproxFogLightColor=(R=0.5,G=0.5,B=0.7,A=1.0)
	StartDistance=0.0
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Class file time: to 6-1-2011 07:10:38.000 - Creation time: ti 22-3-2011 19:57:05.629 - Created with UnCodeX