I3DShAtmosphericShader Struct Reference
[Shell Interfaces]

Inheritance diagram for I3DShAtmosphericShader:
IMCUnknown

List of all members.

Public Member Functions

virtual void MCCOMAPI GetScene (I3DShScene **scene)=0
virtual void MCCOMAPI PrepareRender ()=0
virtual void MCCOMAPI EndRender ()=0
virtual void MCCOMAPI GetLightInfo (TAtmosphericLightInfo &info, EAtmosphericLightType lightType)=0
virtual void MCCOMAPI SetLightInfo (TAtmosphericLightInfo &info, EAtmosphericLightType lightType)=0

Detailed Description

There are two interfaces to access a component: The shell interface (ISh. or I3DSh.) and the external interface (IEx. or I3DEx.) . You can get one from the other using QueryInterface.

Whenever it is possible you should use the Shell interface to access the component because the Shell will make sure that the parameter map of the external component is valid. This is especially important if the component is animated. For more information on components see the Overview of the SDK.

To access the Atmosphere, you should use I3DShEnvironment to make sure that it is properly validated.


Member Function Documentation

virtual void MCCOMAPI I3DShAtmosphericShader::EndRender (  )  [pure virtual]

Will be called after each rendering frame

virtual void MCCOMAPI I3DShAtmosphericShader::GetLightInfo ( TAtmosphericLightInfo info,
EAtmosphericLightType  lightType 
) [pure virtual]
Parameters:
info The info about the sun or moon light position, color...
lightType kMoonLight or kSunLight
virtual void MCCOMAPI I3DShAtmosphericShader::GetScene ( I3DShScene **  scene  )  [pure virtual]

Returns the scene that contains this Atmosphere.

virtual void MCCOMAPI I3DShAtmosphericShader::PrepareRender (  )  [pure virtual]

Will be called before each rendering frame

virtual void MCCOMAPI I3DShAtmosphericShader::SetLightInfo ( TAtmosphericLightInfo info,
EAtmosphericLightType  lightType 
) [pure virtual]
Parameters:
info The info about the sun or moon light position, color...
lightType kMoonLight or kSunLight

The documentation for this struct was generated from the following file:
Generated on Mon Apr 26 22:47:39 2010 for Carrara SDK Doc by  doxygen 1.6.3