I3DExBackground Struct Reference
[External Interfaces]

Inheritance diagram for I3DExBackground:
IMCUnknown TBasicBackground

List of all members.

Public Member Functions

virtual MCCOMErr MCCOMAPI GetBackgroundColor (TMCColorRGB &resultColor, boolean &fullAreaDone, const TVector3 &direction)=0

Detailed Description

Backgrounds are 3D environments that can be reflected on the 3D objects surfaces (like a sky). The background is also used for refractive objects. The background can be considered as texture mapped on an infinite sphere.

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.


Member Function Documentation

virtual MCCOMErr MCCOMAPI I3DExBackground::GetBackgroundColor ( TMCColorRGB resultColor,
boolean fullAreaDone,
const TVector3 direction 
) [pure virtual]

Returns the color of the background in a particular direction.

Parameters:
resultColor The color in the given direction.
fullAreaDone Not used.
direction A unit vector defining the direction on the unit sphere

Implemented in TBasicBackground.


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