IFXView

The IFXView interface contains all view or camera information for the scenegraph.

Interface Methods

Description

Aspect

Gets the view aspect

GetViewResource

Gets the view resource

GetViewResourceID

Gets the view resource ID

SetViewResourceID

Sets the view resource ID

GetLayerCount

Gets the number of layers

InsertLayer

Inserts a layer

AddLayer

Adds a layer

RemoveLayer

Removes a layer

GetLayerLoc

Gets the layer location

SetLayerLoc

Sets the layer location

GetLayerSource

Gets the layer source

SetLayerSource

Sets the layer source

GetLayerScale

Gets the layer scale

SetLayerScale

Sets the layer scale

GetLayerRotation

Gets the layer rotation

SetLayerRotation

Sets the layer rotation

GetLayerRegPoint

Gets the layer location

SetLayerRegPoint

Sets the layer location

GetLayerBgColor

Gets the layer background color

SetLayerBgColor

Sets the layer background color

GetLayerBlend

Gets the layer blend

SetLayerBlend

Sets the layer blend

ClipPlane

Returns the clip plane ID

GetClearState

Gets the clear state

GetClearValue

Gets the clear value

GetDistanceToProjectionPlane

Gets distance to projection plane

GetFarClip

Gets far clip

GetLayer

Gets layer

GetNearClip

Gets near clip

GetNextView

Gets the next view

GetOffset

Gets the view offset

GetOrthoHeight

Gets the orthogonal height

GetProjection

Gets the projection

GetProjectionMode

Gets the projection mode

GetRootNode

Gets the root node

GetSize

Gets the size

GetTrackNode

Gets the track node

PickMultiple

Picks multiple views

Pick

Picks a view

WindowToFilm

Gets pointer to film

RenderView

Renders view

RenderView

Renders view

SetClearState

Sets a clear state

SetClearValue

Sets a clear value

SetFarClip

Sets a far clip

SetLayer

Sets a layer

SetNearClip

Sets a near clip

SetNextView

Sets the next view

SetOffset

Sets the offset

SetOrthoHeight

Sets the orthogonal height

SetProjection

Sets the projection

SetProjectionMode

Sets the projection mode

SetRootNode

Sets the root node

SetSize

Sets the size

SetOriginalSize

Sets the original size

SetTrackNode

Sets the track node

AddModelToVisibleSet

Adds a model to the view

GetVisibility

Gets the vectors that render the scene visible

GetFogEnableValue, etc.

Gets fog effect values, etc.


IFXView::Aspect()

Gets the view aspect.

Parameters:

None

Return Values:

F32


IFXView::GetViewResource(IFXViewResource**)

This method gets the view resource.

Parameters:

IFXViewResource

Handle to the view resource

Return Values


 IFXView GetViewResourceID(U32*)

This method gets the view resource ID.

Parameters:

ViewResourceID

Pointer to the view resource ID number

Return Values


IFXView::SetViewResourceID(U32)

This method sets the view resource ID

Parameters:

ViewResourceID

View resource ID number

Return Values


IFXView::GetLayerCount(U32 uLayer, U32 *pLayerCount)

Parameters:

uLayer

Layer ID number

pLayerCount

Layer count

Return Values


IFXView::InsertLayer(U32 uLayer, U32 uIndex, U32 uTexture, F32 fXLoc, F32 fYLoc, F32 fRotation,SGVector vBgColor)

Parameters:

uLayer

Layer number

uIndex

Index number

uTexture

Texture number

fXLoc

X-axis location

fYLoc

Y-axis location

fRotation

Rotation angle

vBgColor

Background color

Return Values


IFXView::AddLayer(U32 uLayer, U32 uTexture,F32 fXLoc, F32 fYLoc, F32 fRotation,IFXSGVector vBgColor)

Parameters:

uLayer

Layer number

uIndex

Index number

uTexture

Texture number

fXLoc

X-axis location

fYLoc

Y-axis location

fRotation

Rotation angle

vBgColor

Background color

Return Values


IFXView::RemoveLayer(U32 uLayer, U32 uIndex)

Parameters:

uLayer

Number of layer to be removed

uIndex

Number of index

Return Values


IFXView::GetLayerLoc(U32 uLayer, U32 uIndex, F32 *pfXLoc, F32 *pfYLoc)

Parameters:

uLayer

Layer number

uIndex

Index number

fXLoc

X-axis location

fYLoc

Y-axis location

Return Values


IFXView::SetLayerLoc (U32 uLayer, U32 uIndex, F32 fXLoc, F32 fYLoc)

Parameters:

uLayer

Layer number

uIndex

Index number

fXLoc

X-axis location

fYLoc

Y-axis location

Return Values


IFXView::GetLayerSource (U32 uLayer, U32 uIndex, U32 *puSource)

Parameters:

uLayer

Layer number

uIndex

Index number

puSource

Pointer to the layer source

Return Values


IFXView:: SetLayerSource (U32 uLayer, U32 uIndex, U32 uSource)

Parameters:

uLayer

Layer number

uIndex

Index number

puSource

Pointer to the layer source

Return Values


IFXView::GetLayerScale (U32 uLayer, U32 uIndex, F32 *pfScale)

Parameters:

uLayer

Layer number

uIndex

Index number

pfScale

Pointer to the layer scale

Return Values


IFXView::SetLayerScale (U32 uLayer, U32 uIndex, F32 fScale)

Parameters:

uLayer

Layer number

uIndex

Index number

pfScale

Pointer to the layer scale

Return Values


IFXView::GetLayerRotation (U32 uLayer, U32 uIndex, F32 *pfRotation)

Parameters:

uLayer

Layer number

uIndex

Index number

pfRotation

Pointer to the layer rotation number

Return Values


IFXView::SetLayerRotation (U32 uLayer, U32 uIndex, F32 fRotation)

Parameters:

uLayer

Layer number

uIndex

Index number

pfRotation

Pointer to the layer rotation number

Return Values


IFXView::GetLayerRegPoint (U32 uLayer, U32 uIndex, F32 *pfXLoc, F32 *pfYLoc)

Parameters:

uLayer

Layer number

uIndex

Index number

fXLoc

X-axis location

fYLoc

Y-axis location

Return Values


IFXView::SetLayerRegPoint (U32 uLayer, U32 uIndex, F32 fXLoc, F32 fYLoc)

Parameters:

uLayer

Layer number

uIndex

Index number

fXLoc

X-axis location

fYLoc

Y-axis location

Return Values


IFXView::GetLayerBgColor (U32 uLayer, U32 uIndex, IFXSGVector *pBgColor)

Parameters:

uLayer

Layer number

uIndex

Index number

vBgColor

Background color

Return Values


IFXView::SetLayerBgColor (U32 uLayer, U32 uIndex, IFXSGVector BgColor)

Parameters:

uLayer

Layer number

uIndex

Index number

vBgColor

Background color

Return Values


IFXView::GetLayerBlend (U32 uLayer, U32 uIndex, F32 *pfBlend)

Parameters:

uLayer

Layer number

uIndex

Index number

pfBlend

Blend factor

Return Values


IFXView::SetLayerBlend (U32 uLayer, U32 uIndex, F32 fBlend)

Parameters:

uLayer

Layer number

uIndex

Index number

pfBlend

Blend factor

Return Values


IFXView::ClipPlane( U32 uInClipPlaneId )

Parameters:

uInClipPlaneId

ClipPlane ID number

Return Values:

const IFXSGVector&


IFXView::GetClearState(IFXRenderLayer::EIRLBuffer buffer, BOOL* pClear)

Parameters:

buffer

RenderLayer buffer

pClear

Indicates whether there is a clear state

Return Values


IFXView::GetClearValue(IFXRenderLayer::EIRLBuffer buffer, void* pOutValue)

Parameters:

buffer

RenderLayer buffer

pOutValue

Clear value

Return Values


IFXView::GetDistanceToProjectionPlane()

Parameters:

None

Return Values:

inline F32


IFXView::GetFarClip()

Parameters:

None

Return Values:

inline F32


IFXView::GetLayer(U32* pLayer)

Parameters:

pLayer

Pointer to the layer ID

Return Values


IFXView::F32 GetNearClip()

Parameters:

None

Return Values:

inline


IFXView::GetNextView(IFXView **ppView)

Parameters:

ppView

Pointer to the view to be added

Return Values


IFXView::GetOffset(F32* pX, F32* pY)

Parameters:

pX

X-axis location

pY

Y-axis location

Return Values


IFXView::GetOrthoHeight(F32* pOrthoHeight)

Parameters:

pOrthoHeight

Ortho Height factor

Return Values


IFXView::GetProjection(F32* pProjectionDegrees)

Parameters:

pProjectionDegrees

Projection degrees factor

Return Values


IFXView::GetProjectionMode(EIFXProjectionMode* pProjectionMode)

Parameters:

pProjectionMode

Pointer to IFXProjectionMode

Return Values


IFXView::GetRootNode(IFXNode** ppNode)

Parameters:

ppNode

Pointer to the root node

Return Values


IFXView::GetSize(F32* pWidth, F32* pHeight)

Parameters:

pWidth

Measured width

pHeight

Measured height

Return Values


IFXView::GetTrackNode(IFXNode** ppNode)

Parameters:

ppNode

Pointer to the track node

Return Values


IFXView::PickMultiple(F32 x, F32 y, IFXModel*** pppOutPickedModelList, U32* puNumModels)

Parameters:

x

X-axis location

y

Y-axis location

pppOutPickedModelList

Pointer to the IFXModel selected

puNumModels

Pointer to the model ID number

Return Values


IFXView::Pick(F32 x, F32 y, IFXModel** ppOutPickedModel)

Parameters:

x

X-axis location

y

Y-axis location

pppOutPickedModelList

Pointer to the IFXModel selected

Return Values


IFXView::WindowToFilm(F32 x, F32 y, IFXSGVector* pFilmPt)

Parameters:

x

X-axis location

y

Y-axis location

pFilmPt

Pointer to the film point

Return Values


IFXView::RenderView(IFXRenderLayer* pRenderLayer,int inX=0,int inY=0)

Parameters:

pRenderLayer

Pointer to the RenderLayer

inX=0

X-axis coordinate (default is 0)

inY=0

Y-axis coordinate (default is 0)

Return Values


 OR

IFXView::RenderView(IFXRenderLayer* pRenderLayer)

Parameters:

pRenderLayer

Pointer to the RenderLayer

Return Values


IFXView::SetClearState(IFXRenderLayer::EIRLBuffer bufferBits, BOOL clear)

Parameters:

bufferBits

RenderLayer buffer bits

clear

Indicates whether the clear state has been set

Return Values


IFXView::SetClearValue(IFXRenderLayer::EIRLBuffer buffer, void* pInValue)

Parameters:

buffer

RenderLayer buffer bits

pInValue

Sets the clear value

Return Values


IFXView::SetFarClip(F32 distance)

Parameters:

distance

Far clip distance

Return Values


IFXView::SetLayer(U32 layer)

Parameters:

layer

Layer ID number

Return Values


IFXView::SetNearClip(F32 distance)

Parameters:

distance

Near clip distance

Return Values


IFXView::SetNextView(IFXView *pView)

Parameters:

pView

The view to be set

Return Values


IFXView::SetOffset(F32 x, F32 y)

Parameters:

x

Offset on x axis

y

Offset on y axis

Return Values


IFXView::SetOrthoHeight(F32 orthoHeight)

Parameters:

orthoHeight

Ortho Height

Return Values


IFXView::SetProjection(F32 degrees)

Parameters:

degrees

Projection angle degrees

Return Values


IFXView::SetProjectionMode(EIFXProjectionMode projectionMode)

Parameters:

projectionMode

IFXProjectionMode

Return Values


IFXView::SetRootNode(IFXNode* pRootNode)

Parameters:

pRootNode

Pointer to the root node

Return Values


IFXView::SetSize(F32 width, F32 height)

This method is identical to SetOriginalSize() except for name. It is necessary, however, to call SetOriginalSize() before calling this method.

Parameters:

width

Width of the view

height

Height of the view

Return Values


IFXView::SetOriginalSize(F32 width, F32 height)

This method is identical to SetSize() except for name. It is necessary, however, to call this method before calling SetSize().

Parameters:

width

Width of the view

height

Height of the view

Return Values


IFXView::SetTrackNode(IFXNode* pTrackNode)

Parameters:

pTrackNode

Pointer to the track node

Return Values


IFXView::AddModelToVisibleSet(IFXModel* pModel)

Parameters:

pModel

Pointer to the model to be added to the view

Return Values:

None


IFXView::GetVisibility(IFXSGVector* pInSphere)

Parameters:

pInSphere

Pointer to the IFXSGVectors to make the scene visible

Return Values:

Visibility

 


IFXView::GetFogEnableValue( BOOL* pbEnable )

Parameters:

pbEnable

Indicates whether fog is enabled

Return Values


IFXView::FogEnable( BOOL bEnable )

Parameters:

pbEnable

Indicates whether fog is enabled

Return Values


IFXView::GetFogColor( IFXSGVector* pvColor )

Parameters:

pvColor

Color value of the fog

Return Values


IFXView::GetFogDecayMode( EIFXFog* eDecayMode )

Parameters:

eDecayMode

Decay rate of the fog

Return Values


IFXView::GetFogNearValue( F32* pfNearValue )

Parameters:

pfNearValue

Near value of the fog

Return Values


IFXView::GetFogFarValue( F32* pfFarValue )

Parameters:

pfFarValue

Far value of the fog

Return Values


 IFXView::GetFogDensity( F32* pfDensity )

Parameters:

pfDensity

Density value of the fog

Return Values


IFXView::SetFogColor( IFXSGVector vColor )

Parameters:

vColor

Color value of the fog

Return Values


IFXView::SetFogDecayMode( EIFXFog eDecayMode )

Parameters:

eDecayMode

Decay value of the fog

Return Values


IFXView::SetFogNearValue( F32 fNearValue )

Parameters:

fNearValue

Near value of the fog

Return Values


IFXView::SetFogFarValue( F32 fFarValue )

Parameters:

fFarValue

Far value of the fog

Return Values


 

§See asterisked (*) statement at Legal Information © 2001 Intel Corporation.