Graphic3d_WorldViewProjState Class Reference

Helper class for keeping reference on world-view-projection state. Helpful for synchronizing state of WVP dependent data structures. More...

#include <Graphic3d_WorldViewProjState.hxx>

Public Member Functions
	Graphic3d_WorldViewProjState ()
	Default constructor.
	Graphic3d_WorldViewProjState (const Standard_Size theProjectionState, const Standard_Size theWorldViewState, const Standard_Transient *theCamera=NULL)
	Constructor for custom projector type.
Standard_Boolean	IsValid ()
	Check state validity.
void	Reset ()
	Invalidate world view projection state.
void	Initialize (const Standard_Size theProjectionState, const Standard_Size theWorldViewState, const Standard_Transient *theCamera=NULL)
	Initialize world view projection state.
void	Initialize (const Standard_Transient *theCamera=NULL)
	Initialize world view projection state.
Standard_Size &	ProjectionState ()
Standard_Size &	WorldViewState ()
Standard_Boolean	IsProjectionChanged (const Graphic3d_WorldViewProjState &theState)
	Compare projection with other state.
Standard_Boolean	IsWorldViewChanged (const Graphic3d_WorldViewProjState &theState)
	Compare world view transformation with other state.
Standard_Boolean	IsChanged (const Graphic3d_WorldViewProjState &theState)
	Compare with other world view projection state.
bool	operator!= (const Graphic3d_WorldViewProjState &theOther) const
	Compare with other world view projection state.
bool	operator== (const Graphic3d_WorldViewProjState &theOther) const
	Compare with other world view projection state.
void	DumpJson (Standard_OStream &theOStream, Standard_Integer) const
	Dumps the content of me into the stream.

Detailed Description

Helper class for keeping reference on world-view-projection state. Helpful for synchronizing state of WVP dependent data structures.

Constructor & Destructor Documentation

Graphic3d_WorldViewProjState() [1/2]

Graphic3d_WorldViewProjState::Graphic3d_WorldViewProjState ( )

inline

Default constructor.

Graphic3d_WorldViewProjState() [2/2]

Graphic3d_WorldViewProjState::Graphic3d_WorldViewProjState ( const Standard_Size theProjectionState, const Standard_Size theWorldViewState, const Standard_Transient * theCamera = NULL )

inline

Constructor for custom projector type.

Parameters

[in]	theProjectionState	the projection state.
[in]	theWorldViewState	the world view state.
[in]	theCamera	the pointer to the class supplying projection and world view matrices (camera).

Member Function Documentation

DumpJson()

void Graphic3d_WorldViewProjState::DumpJson ( Standard_OStream & theOStream, Standard_Integer  ) const

inline

Dumps the content of me into the stream.

Initialize() [1/2]

void Graphic3d_WorldViewProjState::Initialize ( const Standard_Size theProjectionState, const Standard_Size theWorldViewState, const Standard_Transient * theCamera = NULL )

inline

Initialize world view projection state.

Initialize() [2/2]

void Graphic3d_WorldViewProjState::Initialize ( const Standard_Transient * theCamera = NULL )

inline

Initialize world view projection state.

IsChanged()

Standard_Boolean Graphic3d_WorldViewProjState::IsChanged ( const Graphic3d_WorldViewProjState & theState )

inline

Compare with other world view projection state.

Returns

true when the projection of the given camera state differs from this one.

IsProjectionChanged()

Standard_Boolean Graphic3d_WorldViewProjState::IsProjectionChanged ( const Graphic3d_WorldViewProjState & theState )

inline

Compare projection with other state.

Returns

true when the projection of the given camera state differs from this one.

IsValid()

Standard_Boolean Graphic3d_WorldViewProjState::IsValid ( )

inline

Check state validity.

Returns

true if state is set.

IsWorldViewChanged()

Standard_Boolean Graphic3d_WorldViewProjState::IsWorldViewChanged ( const Graphic3d_WorldViewProjState & theState )

inline

Compare world view transformation with other state.

Returns

true when the orientation of the given camera state differs from this one.

operator!=()

bool Graphic3d_WorldViewProjState::operator!= ( const Graphic3d_WorldViewProjState & theOther ) const

inline

Compare with other world view projection state.

Returns

true if the other projection state is different to this one.

operator==()

bool Graphic3d_WorldViewProjState::operator== ( const Graphic3d_WorldViewProjState & theOther ) const

inline

Compare with other world view projection state.

Returns

true if the other projection state is equal to this one.

ProjectionState()

Standard_Size & Graphic3d_WorldViewProjState::ProjectionState ( )

inline

Returns

projection state counter.

Reset()

void Graphic3d_WorldViewProjState::Reset ( )

inline

Invalidate world view projection state.

WorldViewState()

Standard_Size & Graphic3d_WorldViewProjState::WorldViewState ( )

inline

Returns

world view state counter.

---

The documentation for this class was generated from the following file:

• Graphic3d_WorldViewProjState.hxx