OpenGl_Workspace Class Reference

Reprepsents window with GL context. Provides methods to render primitives and maintan GL state.

#include <OpenGl_Workspace.hxx>

Inheritance diagram for OpenGl_Workspace:

Public Member Functions
	OpenGl_Workspace (const Handle< OpenGl_Display > &theDisplay, const CALL_DEF_WINDOW &theCWindow, Aspect_RenderingContext theGContext, const Handle< OpenGl_Context > &theShareCtx)
	Main constructor - prepare GL context for specified window.
virtual	~OpenGl_Workspace ()
	Destructor.
void	SetActiveView (const Handle< OpenGl_View > &theView)
const Handle< OpenGl_View > &	ActiveView () const
void	Redraw (const Graphic3d_CView &theCView, const Aspect_CLayer2d &theCUnderLayer, const Aspect_CLayer2d &theCOverLayer)
	Redraw the window.
void	Update (const Graphic3d_CView &theCView, const Aspect_CLayer2d &theCUnderLayer, const Aspect_CLayer2d &theCOverLayer)
	Deprecated. Simply calls Redraw().
Standard_Boolean	Print (const Graphic3d_CView &theCView, const Aspect_CLayer2d &theCUnderLayer, const Aspect_CLayer2d &theCOverLayer, const Aspect_Handle theHPrintDC, const Standard_Boolean theToShowBackground, const Standard_CString theFileName, const Aspect_PrintAlgo thePrintAlgorithm, const Standard_Real theScaleFactor)
	Special method to perform printing. System-specific and currently only Win platform implemented.
void	DisplayCallback (const Graphic3d_CView &theCView, int theReason)
void	BeginAnimation (const Standard_Boolean theUseDegeneration, const Standard_Boolean theUpdateAM)
void	EndAnimation ()
void	EraseAnimation ()
Standard_Boolean	BeginAddMode ()
void	EndAddMode ()
void	ClearImmediatMode (const Graphic3d_CView &theCView, const Standard_Boolean theToFlush)
void	RedrawImmediatMode ()
Standard_Boolean	BeginImmediatMode (const Graphic3d_CView &theCView, const Standard_Boolean theUseDepthTest, const Standard_Boolean theRetainMode)
void	EndImmediatMode ()
void	Transform (const TColStd_Array2OfReal &theMatrix, const Graphic3d_TypeOfComposition theType)
void	DrawStructure (const OpenGl_Structure *theStructure)
void	BeginPolyline ()
void	EndPolyline ()
void	Draw (const Standard_ShortReal theX, const Standard_ShortReal theY, const Standard_ShortReal theZ)
void	Move (const Standard_ShortReal theX, const Standard_ShortReal theY, const Standard_ShortReal theZ)
void	SetLineColor (const Standard_ShortReal theR, const Standard_ShortReal theG, const Standard_ShortReal theB)
void	SetLineType (const Standard_Integer theType)
void	SetLineWidth (const Standard_ShortReal theWidth)
void	SetMinMax (const Standard_ShortReal X1, const Standard_ShortReal Y1, const Standard_ShortReal Z1, const Standard_ShortReal X2, const Standard_ShortReal Y2, const Standard_ShortReal Z2)
Graphic3d_PtrFrameBuffer	FBOCreate (const Standard_Integer theWidth, const Standard_Integer theHeight)
void	FBORelease (Graphic3d_PtrFrameBuffer theFBOPtr)
Standard_Boolean	BufferDump (OpenGl_FrameBuffer *theFBOPtr, Image_PixMap &theImage, const Graphic3d_BufferType &theBufferType)
void	UseTransparency (const Standard_Boolean theFlag)
Standard_Boolean &	UseZBuffer ()
Standard_Boolean &	UseDepthTest ()
Standard_Boolean &	UseGLLight ()
const OpenGl_Matrix *	SetViewMatrix (const OpenGl_Matrix *)
const OpenGl_Matrix *	SetStructureMatrix (const OpenGl_Matrix *)
const OpenGl_AspectLine *	SetAspectLine (const OpenGl_AspectLine *theAspect)
const OpenGl_AspectFace *	SetAspectFace (const OpenGl_AspectFace *theAspect)
const OpenGl_AspectMarker *	SetAspectMarker (const OpenGl_AspectMarker *theAspect)
const OpenGl_AspectText *	SetAspectText (const OpenGl_AspectText *theAspect)
void	SetTextParam (const OpenGl_TextParam *theParam)
const OpenGl_AspectLine *	AspectLine (const Standard_Boolean theWithApply)
const OpenGl_AspectFace *	AspectFace (const Standard_Boolean theWithApply)
const OpenGl_AspectMarker *	AspectMarker (const Standard_Boolean theWithApply)
const OpenGl_AspectText *	AspectText (const Standard_Boolean theWithApply)
void	ResetAppliedAspect ()
	Clear the applied aspect state.
int	FindFont (const char *theFontName, const Font_FontAspect theFontAspect, const int theBestSize=-1, const float theXScale=1.0f, const float theYScale=1.0f)
void	StringSize (const wchar_t *theText, int &theWidth, int &theAscent, int &theDescent)
void	RenderText (const wchar_t *theText, const int theIs2d, const float theX, const float theY, const float theZ)
Data Fields
Standard_Integer	NamedStatus
Standard_Integer	DegenerateModel
Standard_ShortReal	SkipRatio
const TEL_COLOUR *	HighlightColor
Protected Member Functions
void	CopyBuffers (Tint vid, int FrontToBack, Tfloat xm, Tfloat ym, Tfloat zm, Tfloat XM, Tfloat YM, Tfloat ZM, Tint flag)
virtual Standard_Boolean	Activate ()
	Makes GL context for this window active in current thread.
void	Redraw1 (const Graphic3d_CView &theCView, const Aspect_CLayer2d &theCUnderLayer, const Aspect_CLayer2d &theCOverLayer, const int theToSwap)
void	UpdateMaterial (const int flag)
Protected Attributes
Handle< OpenGl_View >	myView
Tint	myTransientList
Standard_Boolean	myIsTransientOpen
Tint	myRetainMode
Standard_Boolean	myUseTransparency
Standard_Boolean	myUseZBuffer
Standard_Boolean	myUseDepthTest
Standard_Boolean	myUseGLLight
Standard_Boolean	myBackBufferRestored
const OpenGl_AspectLine *	AspectLine_set
const OpenGl_AspectLine *	AspectLine_applied
const OpenGl_AspectFace *	AspectFace_set
const OpenGl_AspectFace *	AspectFace_applied
const OpenGl_AspectMarker *	AspectMarker_set
const OpenGl_AspectMarker *	AspectMarker_applied
const OpenGl_AspectText *	AspectText_set
const OpenGl_AspectText *	AspectText_applied
const OpenGl_TextParam *	TextParam_set
const OpenGl_TextParam *	TextParam_applied
const OpenGl_Matrix *	ViewMatrix_applied
const OpenGl_Matrix *	StructureMatrix_applied
const TEL_POFFSET_PARAM *	PolygonOffset_applied

---

Constructor & Destructor Documentation

OpenGl_Workspace::OpenGl_Workspace	(	const Handle< OpenGl_Display > &	theDisplay,
		const CALL_DEF_WINDOW &	theCWindow,
		Aspect_RenderingContext	theGContext,
		const Handle< OpenGl_Context > &	theShareCtx
	)

virtual OpenGl_Workspace::~OpenGl_Workspace

(

)

[virtual]

---

Member Function Documentation

virtual Standard_Boolean OpenGl_Workspace::Activate

(

)

[protected, virtual]

Reimplemented from OpenGl_Window.

const Handle< OpenGl_View >& OpenGl_Workspace::ActiveView

(

)

const [inline]

const OpenGl_AspectFace* OpenGl_Workspace::AspectFace

(

const Standard_Boolean

theWithApply

)

const OpenGl_AspectLine* OpenGl_Workspace::AspectLine

(

const Standard_Boolean

theWithApply

)

const OpenGl_AspectMarker* OpenGl_Workspace::AspectMarker

(

const Standard_Boolean

theWithApply

)

const OpenGl_AspectText* OpenGl_Workspace::AspectText

(

const Standard_Boolean

theWithApply

)

Standard_Boolean OpenGl_Workspace::BeginAddMode

(

)

void OpenGl_Workspace::BeginAnimation	(	const Standard_Boolean	theUseDegeneration,
		const Standard_Boolean	theUpdateAM
	)

Standard_Boolean OpenGl_Workspace::BeginImmediatMode	(	const Graphic3d_CView &	theCView,
		const Standard_Boolean	theUseDepthTest,
		const Standard_Boolean	theRetainMode
	)

void OpenGl_Workspace::BeginPolyline

(

)

Standard_Boolean OpenGl_Workspace::BufferDump	(	OpenGl_FrameBuffer *	theFBOPtr,
		Image_PixMap &	theImage,
		const Graphic3d_BufferType &	theBufferType
	)

void OpenGl_Workspace::ClearImmediatMode	(	const Graphic3d_CView &	theCView,
		const Standard_Boolean	theToFlush
	)

void OpenGl_Workspace::CopyBuffers	(	Tint	vid,
		int	FrontToBack,
		Tfloat	xm,
		Tfloat	ym,
		Tfloat	zm,
		Tfloat	XM,
		Tfloat	YM,
		Tfloat	ZM,
		Tint	flag
	)		[protected]

void OpenGl_Workspace::DisplayCallback	(	const Graphic3d_CView &	theCView,
		int	theReason
	)

void OpenGl_Workspace::Draw	(	const Standard_ShortReal	theX,
		const Standard_ShortReal	theY,
		const Standard_ShortReal	theZ
	)

void OpenGl_Workspace::DrawStructure

(

const OpenGl_Structure *

theStructure

)

void OpenGl_Workspace::EndAddMode

(

)

void OpenGl_Workspace::EndAnimation

(

)

void OpenGl_Workspace::EndImmediatMode

(

)

void OpenGl_Workspace::EndPolyline

(

)

void OpenGl_Workspace::EraseAnimation

(

)

Graphic3d_PtrFrameBuffer OpenGl_Workspace::FBOCreate	(	const Standard_Integer	theWidth,
		const Standard_Integer	theHeight
	)

void OpenGl_Workspace::FBORelease

(

Graphic3d_PtrFrameBuffer

theFBOPtr

)

int OpenGl_Workspace::FindFont	(	const char *	theFontName,
		const Font_FontAspect	theFontAspect,
		const int	theBestSize = -1,
		const float	theXScale = 1.0f,
		const float	theYScale = 1.0f
	)		[inline]

void OpenGl_Workspace::Move	(	const Standard_ShortReal	theX,
		const Standard_ShortReal	theY,
		const Standard_ShortReal	theZ
	)

Standard_Boolean OpenGl_Workspace::Print	(	const Graphic3d_CView &	theCView,
		const Aspect_CLayer2d &	theCUnderLayer,
		const Aspect_CLayer2d &	theCOverLayer,
		const Aspect_Handle	theHPrintDC,
		const Standard_Boolean	theToShowBackground,
		const Standard_CString	theFileName,
		const Aspect_PrintAlgo	thePrintAlgorithm,
		const Standard_Real	theScaleFactor
	)

void OpenGl_Workspace::Redraw	(	const Graphic3d_CView &	theCView,
		const Aspect_CLayer2d &	theCUnderLayer,
		const Aspect_CLayer2d &	theCOverLayer
	)

void OpenGl_Workspace::Redraw1	(	const Graphic3d_CView &	theCView,
		const Aspect_CLayer2d &	theCUnderLayer,
		const Aspect_CLayer2d &	theCOverLayer,
		const int	theToSwap
	)		[protected]

void OpenGl_Workspace::RedrawImmediatMode

(

)

void OpenGl_Workspace::RenderText	(	const wchar_t *	theText,
		const int	theIs2d,
		const float	theX,
		const float	theY,
		const float	theZ
	)		[inline]

void OpenGl_Workspace::ResetAppliedAspect

(

)

void OpenGl_Workspace::SetActiveView

(

const Handle< OpenGl_View > &

theView

)

[inline]

const OpenGl_AspectFace* OpenGl_Workspace::SetAspectFace

(

const OpenGl_AspectFace *

theAspect

)

const OpenGl_AspectLine* OpenGl_Workspace::SetAspectLine

(

const OpenGl_AspectLine *

theAspect

)

const OpenGl_AspectMarker* OpenGl_Workspace::SetAspectMarker

(

const OpenGl_AspectMarker *

theAspect

)

const OpenGl_AspectText* OpenGl_Workspace::SetAspectText

(

const OpenGl_AspectText *

theAspect

)

void OpenGl_Workspace::SetLineColor	(	const Standard_ShortReal	theR,
		const Standard_ShortReal	theG,
		const Standard_ShortReal	theB
	)

void OpenGl_Workspace::SetLineType

(

const Standard_Integer

theType

)

void OpenGl_Workspace::SetLineWidth

(

const Standard_ShortReal

theWidth

)

void OpenGl_Workspace::SetMinMax	(	const Standard_ShortReal	X1,
		const Standard_ShortReal	Y1,
		const Standard_ShortReal	Z1,
		const Standard_ShortReal	X2,
		const Standard_ShortReal	Y2,
		const Standard_ShortReal	Z2
	)

const OpenGl_Matrix* OpenGl_Workspace::SetStructureMatrix

(

const OpenGl_Matrix *

)

void OpenGl_Workspace::SetTextParam

(

const OpenGl_TextParam *

theParam

)

[inline]

const OpenGl_Matrix* OpenGl_Workspace::SetViewMatrix

(

const OpenGl_Matrix *

)

void OpenGl_Workspace::StringSize	(	const wchar_t *	theText,
		int &	theWidth,
		int &	theAscent,
		int &	theDescent
	)		[inline]

void OpenGl_Workspace::Transform	(	const TColStd_Array2OfReal &	theMatrix,
		const Graphic3d_TypeOfComposition	theType
	)

void OpenGl_Workspace::Update	(	const Graphic3d_CView &	theCView,
		const Aspect_CLayer2d &	theCUnderLayer,
		const Aspect_CLayer2d &	theCOverLayer
	)		[inline]

void OpenGl_Workspace::UpdateMaterial

(

const int

flag

)

[protected]

Standard_Boolean& OpenGl_Workspace::UseDepthTest

(

)

[inline]

Standard_Boolean& OpenGl_Workspace::UseGLLight

(

)

[inline]

void OpenGl_Workspace::UseTransparency

(

const Standard_Boolean

theFlag

)

Standard_Boolean& OpenGl_Workspace::UseZBuffer

(

)

[inline]

---

Field Documentation

const OpenGl_AspectFace * OpenGl_Workspace::AspectFace_applied [protected]

const OpenGl_AspectFace* OpenGl_Workspace::AspectFace_set [protected]

const OpenGl_AspectLine * OpenGl_Workspace::AspectLine_applied [protected]

const OpenGl_AspectLine* OpenGl_Workspace::AspectLine_set [protected]

const OpenGl_AspectMarker * OpenGl_Workspace::AspectMarker_applied [protected]

const OpenGl_AspectMarker* OpenGl_Workspace::AspectMarker_set [protected]

const OpenGl_AspectText * OpenGl_Workspace::AspectText_applied [protected]

const OpenGl_AspectText* OpenGl_Workspace::AspectText_set [protected]

Standard_Integer OpenGl_Workspace::DegenerateModel

const TEL_COLOUR* OpenGl_Workspace::HighlightColor

Standard_Boolean OpenGl_Workspace::myBackBufferRestored [protected]

Standard_Boolean OpenGl_Workspace::myIsTransientOpen [protected]

Tint OpenGl_Workspace::myRetainMode [protected]

Tint OpenGl_Workspace::myTransientList [protected]

Standard_Boolean OpenGl_Workspace::myUseDepthTest [protected]

Standard_Boolean OpenGl_Workspace::myUseGLLight [protected]

Standard_Boolean OpenGl_Workspace::myUseTransparency [protected]

Standard_Boolean OpenGl_Workspace::myUseZBuffer [protected]

Handle< OpenGl_View > OpenGl_Workspace::myView [protected]

Standard_Integer OpenGl_Workspace::NamedStatus

const TEL_POFFSET_PARAM* OpenGl_Workspace::PolygonOffset_applied [protected]

Standard_ShortReal OpenGl_Workspace::SkipRatio

const OpenGl_Matrix* OpenGl_Workspace::StructureMatrix_applied [protected]

const OpenGl_TextParam * OpenGl_Workspace::TextParam_applied [protected]

const OpenGl_TextParam* OpenGl_Workspace::TextParam_set [protected]

const OpenGl_Matrix* OpenGl_Workspace::ViewMatrix_applied [protected]

---

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

• OpenGl_Workspace.hxx