1 // Created on: 2015-01-16
2 // Created by: Anastasia BORISOVA
3 // Copyright (c) 2015 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #include <OpenGl_BackgroundArray.hxx>
18 #include <Aspect_FillMethod.hxx>
19 #include <NCollection_AlignedAllocator.hxx>
20 #include <OpenGl_Texture.hxx>
21 #include <OpenGl_View.hxx>
22 #include <Graphic3d_TextureParams.hxx>
24 // =======================================================================
25 // method : Constructor
27 // =======================================================================
28 OpenGl_BackgroundArray::OpenGl_BackgroundArray (const Graphic3d_TypeOfBackground theType)
29 : OpenGl_PrimitiveArray (NULL, Graphic3d_TOPA_TRIANGLESTRIPS, NULL, NULL, NULL),
31 myFillMethod (Aspect_FM_NONE),
34 myToUpdate (Standard_False)
36 myDrawMode = GL_TRIANGLE_STRIP;
39 myGradientParams.color1 = OpenGl_Vec4 (0.0f, 0.0f, 0.0f, 1.0f);
40 myGradientParams.color2 = OpenGl_Vec4 (0.0f, 0.0f, 0.0f, 1.0f);
41 myGradientParams.type = Aspect_GFM_NONE;
44 // =======================================================================
45 // method : SetTextureParameters
47 // =======================================================================
48 void OpenGl_BackgroundArray::SetTextureParameters (const Aspect_FillMethod theFillMethod)
50 if (myType != Graphic3d_TOB_TEXTURE)
55 myFillMethod = theFillMethod;
59 // =======================================================================
60 // method : SetTextureFillMethod
62 // =======================================================================
63 void OpenGl_BackgroundArray::SetTextureFillMethod (const Aspect_FillMethod theFillMethod)
65 myFillMethod = theFillMethod;
69 // =======================================================================
70 // method : SetGradientParameters
72 // =======================================================================
73 void OpenGl_BackgroundArray::SetGradientParameters (const Quantity_Color& theColor1,
74 const Quantity_Color& theColor2,
75 const Aspect_GradientFillMethod theType)
77 if (myType != Graphic3d_TOB_GRADIENT)
82 Standard_Real anR, aG, aB;
83 theColor1.Values (anR, aG, aB, Quantity_TOC_RGB);
84 myGradientParams.color1 = OpenGl_Vec4 ((float)anR, (float)aG, (float)aB, 0.0f);
86 theColor2.Values (anR, aG, aB, Quantity_TOC_RGB);
87 myGradientParams.color2 = OpenGl_Vec4 ((float)anR, (float)aG, (float)aB, 0.0f);
89 myGradientParams.type = theType;
93 // =======================================================================
94 // method : SetGradientFillMethod
96 // =======================================================================
97 void OpenGl_BackgroundArray::SetGradientFillMethod (const Aspect_GradientFillMethod theType)
99 if (myType != Graphic3d_TOB_GRADIENT)
104 myGradientParams.type = theType;
108 // =======================================================================
109 // method : IsDefined
111 // =======================================================================
112 bool OpenGl_BackgroundArray::IsDefined() const
116 case Graphic3d_TOB_GRADIENT: return myGradientParams.type != Aspect_GFM_NONE;
117 case Graphic3d_TOB_TEXTURE: return myFillMethod != Aspect_FM_NONE;
118 case Graphic3d_TOB_CUBEMAP: return Standard_True;
119 case Graphic3d_TOB_NONE: return Standard_False;
121 return Standard_False;
124 // =======================================================================
125 // method : invalidateData
127 // =======================================================================
128 void OpenGl_BackgroundArray::invalidateData()
130 myToUpdate = Standard_True;
133 // =======================================================================
136 // =======================================================================
137 Standard_Boolean OpenGl_BackgroundArray::init (const Handle(OpenGl_Workspace)& theWorkspace) const
139 const Handle(OpenGl_Context)& aCtx = theWorkspace->GetGlContext();
142 case Graphic3d_TOB_GRADIENT:
144 if (!createGradientArray (aCtx))
146 return Standard_False;
150 case Graphic3d_TOB_TEXTURE:
152 if (!createTextureArray (theWorkspace))
154 return Standard_False;
158 case Graphic3d_TOB_CUBEMAP:
160 if (!createCubeMapArray())
162 return Standard_False;
166 case Graphic3d_TOB_NONE:
169 return Standard_False;
176 clearMemoryGL (aCtx);
178 buildVBO (aCtx, Standard_True);
179 myIsVboInit = Standard_True;
181 // Data is up-to-date
182 myToUpdate = Standard_False;
183 return Standard_True;
186 // =======================================================================
187 // method : createGradientArray
189 // =======================================================================
190 Standard_Boolean OpenGl_BackgroundArray::createGradientArray (const Handle(OpenGl_Context)& theCtx) const
192 // Initialize data for primitive array
193 Graphic3d_Attribute aGragientAttribInfo[] =
195 { Graphic3d_TOA_POS, Graphic3d_TOD_VEC2 },
196 { Graphic3d_TOA_COLOR, Graphic3d_TOD_VEC3 }
199 if (myAttribs.IsNull())
201 Handle(NCollection_AlignedAllocator) anAlloc = new NCollection_AlignedAllocator (16);
202 myAttribs = new Graphic3d_Buffer (anAlloc);
204 if (!myAttribs->Init (4, aGragientAttribInfo, 2))
206 return Standard_False;
209 OpenGl_Vec2 aVertices[4] =
211 OpenGl_Vec2(float(myViewWidth), 0.0f),
212 OpenGl_Vec2(float(myViewWidth), float(myViewHeight)),
213 OpenGl_Vec2(0.0f, 0.0f),
214 OpenGl_Vec2(0.0f, float(myViewHeight))
217 float* aCorners[4] = {};
218 float aDiagCorner1[3] = {};
219 float aDiagCorner2[3] = {};
221 switch (myGradientParams.type)
225 aCorners[0] = myGradientParams.color2.ChangeData();
226 aCorners[1] = myGradientParams.color2.ChangeData();
227 aCorners[2] = myGradientParams.color1.ChangeData();
228 aCorners[3] = myGradientParams.color1.ChangeData();
233 aCorners[0] = myGradientParams.color2.ChangeData();
234 aCorners[1] = myGradientParams.color1.ChangeData();
235 aCorners[2] = myGradientParams.color2.ChangeData();
236 aCorners[3] = myGradientParams.color1.ChangeData();
239 case Aspect_GFM_DIAG1:
241 aCorners[0] = myGradientParams.color2.ChangeData();
242 aCorners[3] = myGradientParams.color1.ChangeData();
243 aDiagCorner1[0] = aDiagCorner2[0] = 0.5f * (aCorners[0][0] + aCorners[3][0]);
244 aDiagCorner1[1] = aDiagCorner2[1] = 0.5f * (aCorners[0][1] + aCorners[3][1]);
245 aDiagCorner1[2] = aDiagCorner2[2] = 0.5f * (aCorners[0][2] + aCorners[3][2]);
246 aCorners[1] = aDiagCorner1;
247 aCorners[2] = aDiagCorner2;
250 case Aspect_GFM_DIAG2:
252 aCorners[1] = myGradientParams.color1.ChangeData();
253 aCorners[2] = myGradientParams.color2.ChangeData();
254 aDiagCorner1[0] = aDiagCorner2[0] = 0.5f * (aCorners[1][0] + aCorners[2][0]);
255 aDiagCorner1[1] = aDiagCorner2[1] = 0.5f * (aCorners[1][1] + aCorners[2][1]);
256 aDiagCorner1[2] = aDiagCorner2[2] = 0.5f * (aCorners[1][2] + aCorners[2][2]);
257 aCorners[0] = aDiagCorner1;
258 aCorners[3] = aDiagCorner2;
261 case Aspect_GFM_CORNER1:
263 aVertices[0] = OpenGl_Vec2(float(myViewWidth), float(myViewHeight));
264 aVertices[1] = OpenGl_Vec2(0.0f, float(myViewHeight));
265 aVertices[2] = OpenGl_Vec2(float(myViewWidth), 0.0f);
266 aVertices[3] = OpenGl_Vec2(0.0f, 0.0f);
268 aCorners[0] = myGradientParams.color2.ChangeData();
269 aCorners[1] = myGradientParams.color1.ChangeData();
270 aCorners[2] = myGradientParams.color2.ChangeData();
271 aCorners[3] = myGradientParams.color2.ChangeData();
274 case Aspect_GFM_CORNER2:
276 aCorners[0] = myGradientParams.color2.ChangeData();
277 aCorners[1] = myGradientParams.color1.ChangeData();
278 aCorners[2] = myGradientParams.color2.ChangeData();
279 aCorners[3] = myGradientParams.color2.ChangeData();
282 case Aspect_GFM_CORNER3:
284 aVertices[0] = OpenGl_Vec2(float(myViewWidth), float(myViewHeight));
285 aVertices[1] = OpenGl_Vec2(0.0f, float(myViewHeight));
286 aVertices[2] = OpenGl_Vec2(float(myViewWidth), 0.0f);
287 aVertices[3] = OpenGl_Vec2(0.0f, 0.0f);
289 aCorners[0] = myGradientParams.color2.ChangeData();
290 aCorners[1] = myGradientParams.color2.ChangeData();
291 aCorners[2] = myGradientParams.color1.ChangeData();
292 aCorners[3] = myGradientParams.color2.ChangeData();
295 case Aspect_GFM_CORNER4:
297 aCorners[0] = myGradientParams.color2.ChangeData();
298 aCorners[1] = myGradientParams.color2.ChangeData();
299 aCorners[2] = myGradientParams.color1.ChangeData();
300 aCorners[3] = myGradientParams.color2.ChangeData();
303 case Aspect_GFM_NONE:
309 for (Standard_Integer anIt = 0; anIt < 4; ++anIt)
311 OpenGl_Vec2* aVertData = reinterpret_cast<OpenGl_Vec2* >(myAttribs->changeValue (anIt));
312 *aVertData = aVertices[anIt];
314 OpenGl_Vec3* aColorData = reinterpret_cast<OpenGl_Vec3* >(myAttribs->changeValue (anIt) + myAttribs->AttributeOffset (1));
315 *aColorData = theCtx->Vec4FromQuantityColor (OpenGl_Vec4(aCorners[anIt][0], aCorners[anIt][1], aCorners[anIt][2], 1.0f)).rgb();
318 return Standard_True;
321 // =======================================================================
322 // method : createTextureArray
324 // =======================================================================
325 Standard_Boolean OpenGl_BackgroundArray::createTextureArray (const Handle(OpenGl_Workspace)& theWorkspace) const
327 Graphic3d_Attribute aTextureAttribInfo[] =
329 { Graphic3d_TOA_POS, Graphic3d_TOD_VEC2 },
330 { Graphic3d_TOA_UV, Graphic3d_TOD_VEC2 }
333 if (myAttribs.IsNull())
335 Handle(NCollection_AlignedAllocator) anAlloc = new NCollection_AlignedAllocator (16);
336 myAttribs = new Graphic3d_Buffer (anAlloc);
338 if (!myAttribs->Init (4, aTextureAttribInfo, 2))
340 return Standard_False;
343 GLfloat aTexRangeX = 1.0f; // texture <s> coordinate
344 GLfloat aTexRangeY = 1.0f; // texture <t> coordinate
346 // Set up for stretching or tiling
347 GLfloat anOffsetX = 0.5f * (float )myViewWidth;
348 GLfloat anOffsetY = 0.5f * (float )myViewHeight;
350 // Setting this coefficient to -1.0f allows to tile textures relatively to the top-left corner of the view
351 // (value 1.0f corresponds to the initial behavior - tiling from the bottom-left corner)
352 GLfloat aCoef = -1.0f;
354 // Get texture parameters
355 const Handle(OpenGl_Context)& aCtx = theWorkspace->GetGlContext();
356 const OpenGl_Aspects* anAspectFace = theWorkspace->Aspects();
357 GLfloat aTextureWidth = (GLfloat )anAspectFace->TextureSet (aCtx)->First()->SizeX();
358 GLfloat aTextureHeight = (GLfloat )anAspectFace->TextureSet (aCtx)->First()->SizeY();
360 if (myFillMethod == Aspect_FM_CENTERED)
362 anOffsetX = 0.5f * aTextureWidth;
363 anOffsetY = 0.5f * aTextureHeight;
365 else if (myFillMethod == Aspect_FM_TILED)
367 aTexRangeX = (GLfloat )myViewWidth / aTextureWidth;
368 aTexRangeY = (GLfloat )myViewHeight / aTextureHeight;
371 // NOTE: texture is mapped using GL_REPEAT wrapping mode so integer part
372 // is simply ignored, and negative multiplier is here for convenience only
373 // and does not result e.g. in texture mirroring
376 OpenGl_Vec2* aData = reinterpret_cast<OpenGl_Vec2* >(myAttribs->changeValue (0));
377 aData[0] = OpenGl_Vec2 (anOffsetX, -aCoef * anOffsetY);
378 aData[1] = OpenGl_Vec2 (aTexRangeX, 0.0f);
380 aData = reinterpret_cast<OpenGl_Vec2* >(myAttribs->changeValue (1));
381 aData[0] = OpenGl_Vec2 (anOffsetX, aCoef * anOffsetY);
382 aData[1] = OpenGl_Vec2 (aTexRangeX, aCoef * aTexRangeY);
384 aData = reinterpret_cast<OpenGl_Vec2* >(myAttribs->changeValue (2));
385 aData[0] = OpenGl_Vec2 (-anOffsetX, -aCoef * anOffsetY);
386 aData[1] = OpenGl_Vec2 (0.0f, 0.0f);
388 aData = reinterpret_cast<OpenGl_Vec2* >(myAttribs->changeValue (3));
389 aData[0] = OpenGl_Vec2 (-anOffsetX, aCoef * anOffsetY);
390 aData[1] = OpenGl_Vec2 (0.0f, aCoef * aTexRangeY);
392 return Standard_True;
395 // =======================================================================
396 // method : createCubeMapArray
398 // =======================================================================
399 Standard_Boolean OpenGl_BackgroundArray::createCubeMapArray() const
401 const Graphic3d_Attribute aCubeMapAttribInfo[] =
403 { Graphic3d_TOA_POS, Graphic3d_TOD_VEC3 }
406 if (myAttribs.IsNull())
408 Handle(NCollection_AlignedAllocator) anAlloc = new NCollection_AlignedAllocator (16);
409 myAttribs = new Graphic3d_Buffer (anAlloc);
410 myIndices = new Graphic3d_IndexBuffer (anAlloc);
412 if (!myAttribs->Init (8, aCubeMapAttribInfo, 1)
413 || !myIndices->Init<unsigned short> (14))
415 return Standard_False;
419 OpenGl_Vec3* aData = reinterpret_cast<OpenGl_Vec3*>(myAttribs->changeValue(0));
420 aData[0].SetValues (-1.0, -1.0, 1.0);
421 aData[1].SetValues ( 1.0, -1.0, 1.0);
422 aData[2].SetValues (-1.0, 1.0, 1.0);
423 aData[3].SetValues ( 1.0, 1.0, 1.0);
424 aData[4].SetValues (-1.0, -1.0, -1.0);
425 aData[5].SetValues ( 1.0, -1.0, -1.0);
426 aData[6].SetValues (-1.0, 1.0, -1.0);
427 aData[7].SetValues ( 1.0, 1.0, -1.0);
430 const unsigned short THE_BOX_TRISTRIP[14] = { 0, 1, 2, 3, 7, 1, 5, 4, 7, 6, 2, 4, 0, 1 };
431 for (unsigned int aVertIter = 0; aVertIter < 14; ++aVertIter)
433 myIndices->SetIndex (aVertIter, THE_BOX_TRISTRIP[aVertIter]);
437 return Standard_True;
440 // =======================================================================
443 // =======================================================================
444 void OpenGl_BackgroundArray::Render (const Handle(OpenGl_Workspace)& theWorkspace,
445 Graphic3d_Camera::Projection theProjection) const
447 const Handle(OpenGl_Context)& aCtx = theWorkspace->GetGlContext();
448 Standard_Integer aViewSizeX = aCtx->Viewport()[2];
449 Standard_Integer aViewSizeY = aCtx->Viewport()[3];
450 Graphic3d_Vec2i aTileOffset, aTileSize;
452 if (theWorkspace->View()->Camera()->Tile().IsValid())
454 aViewSizeX = theWorkspace->View()->Camera()->Tile().TotalSize.x();
455 aViewSizeY = theWorkspace->View()->Camera()->Tile().TotalSize.y();
457 aTileOffset = theWorkspace->View()->Camera()->Tile().OffsetLowerLeft();
458 aTileSize = theWorkspace->View()->Camera()->Tile().TileSize;
461 || myViewWidth != aViewSizeX
462 || myViewHeight != aViewSizeY
463 || myAttribs.IsNull()
464 || myVboAttribs.IsNull())
466 myViewWidth = aViewSizeX;
467 myViewHeight = aViewSizeY;
471 OpenGl_Mat4 aProjection = aCtx->ProjectionState.Current();
472 OpenGl_Mat4 aWorldView = aCtx->WorldViewState.Current();
474 if (myType == Graphic3d_TOB_CUBEMAP)
476 Graphic3d_Camera aCamera (theWorkspace->View()->Camera());
477 aCamera.SetZRange (0.01, 1.0); // is needed to avoid perspective camera exception
479 // cancel translation
480 aCamera.MoveEyeTo (gp_Pnt (0.0, 0.0, 0.0));
482 // Handle projection matrix:
483 // - Cancel any head-to-eye translation for HMD display;
484 // - Ignore stereoscopic projection in case of non-HMD 3D display
485 // (ideally, we would need a stereoscopic cubemap image; adding a parallax makes no sense);
486 // - Force perspective projection when orthographic camera is active
487 // (orthographic projection makes no sense for cubemap).
488 const bool isCustomProj = aCamera.IsCustomStereoFrustum()
489 || aCamera.IsCustomStereoProjection();
490 aCamera.SetProjectionType (theProjection == Graphic3d_Camera::Projection_Orthographic || !isCustomProj
491 ? Graphic3d_Camera::Projection_Perspective
494 aProjection = aCamera.ProjectionMatrixF();
495 aWorldView = aCamera.OrientationMatrixF();
498 // get projection matrix without pre-multiplied stereoscopic head-to-eye translation
499 if (theProjection == Graphic3d_Camera::Projection_MonoLeftEye)
501 Graphic3d_Mat4 aMatProjL, aMatHeadToEyeL, aMatProjR, aMatHeadToEyeR;
502 aCamera.StereoProjectionF (aMatProjL, aMatHeadToEyeL, aMatProjR, aMatHeadToEyeR);
503 aProjection = aMatProjL;
505 else if (theProjection == Graphic3d_Camera::Projection_MonoRightEye)
507 Graphic3d_Mat4 aMatProjL, aMatHeadToEyeL, aMatProjR, aMatHeadToEyeR;
508 aCamera.StereoProjectionF (aMatProjL, aMatHeadToEyeL, aMatProjR, aMatHeadToEyeR);
509 aProjection = aMatProjR;
515 aProjection.InitIdentity();
516 aWorldView.InitIdentity();
517 if (theWorkspace->View()->Camera()->Tile().IsValid())
519 aWorldView.SetDiagonal (OpenGl_Vec4 (2.0f / aTileSize.x(), 2.0f / aTileSize.y(), 1.0f, 1.0f));
520 if (myType == Graphic3d_TOB_GRADIENT)
522 aWorldView.SetColumn (3, OpenGl_Vec4 (-1.0f - 2.0f * aTileOffset.x() / aTileSize.x(),
523 -1.0f - 2.0f * aTileOffset.y() / aTileSize.y(), 0.0f, 1.0f));
527 aWorldView.SetColumn (3, OpenGl_Vec4 (-1.0f + (float) aViewSizeX / aTileSize.x() - 2.0f * aTileOffset.x() / aTileSize.x(),
528 -1.0f + (float) aViewSizeY / aTileSize.y() - 2.0f * aTileOffset.y() / aTileSize.y(), 0.0f, 1.0f));
533 aWorldView.SetDiagonal (OpenGl_Vec4 (2.0f / myViewWidth, 2.0f / myViewHeight, 1.0f, 1.0f));
534 if (myType == Graphic3d_TOB_GRADIENT)
536 aWorldView.SetColumn (3, OpenGl_Vec4 (-1.0f, -1.0f, 0.0f, 1.0f));
541 aCtx->ProjectionState.Push();
542 aCtx->WorldViewState.Push();
543 aCtx->ProjectionState.SetCurrent (aProjection);
544 aCtx->WorldViewState.SetCurrent (aWorldView);
545 aCtx->ApplyProjectionMatrix();
546 aCtx->ApplyModelViewMatrix();
548 OpenGl_PrimitiveArray::Render (theWorkspace);
550 aCtx->ProjectionState.Pop();
551 aCtx->WorldViewState.Pop();
552 aCtx->ApplyProjectionMatrix();