panel.go 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960
  1. // Copyright 2016 The G3N Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style
  3. // license that can be found in the LICENSE file.
  4. package gui
  5. import (
  6. "github.com/g3n/engine/core"
  7. "github.com/g3n/engine/geometry"
  8. "github.com/g3n/engine/gls"
  9. "github.com/g3n/engine/graphic"
  10. "github.com/g3n/engine/material"
  11. "github.com/g3n/engine/math32"
  12. )
  13. /*********************************************
  14. Panel areas:
  15. +------------------------------------------+
  16. | Margin area |
  17. | +------------------------------------+ |
  18. | | Border area | |
  19. | | +------------------------------+ | |
  20. | | | Padding area | | |
  21. | | | +------------------------+ | | |
  22. | | | | Content area | | | |
  23. | | | | | | | |
  24. | | | | | | | |
  25. | | | +------------------------+ | | |
  26. | | | | | |
  27. | | +------------------------------+ | |
  28. | | | |
  29. | +------------------------------------+ |
  30. | |
  31. +------------------------------------------+
  32. *********************************************/
  33. // IPanel is the interface for all panel types
  34. type IPanel interface {
  35. graphic.IGraphic
  36. GetPanel() *Panel
  37. Width() float32
  38. Height() float32
  39. Enabled() bool
  40. SetEnabled(bool)
  41. SetLayout(ILayout)
  42. InsideBorders(x, y float32) bool
  43. // TODO these methods here should probably be defined in INode
  44. SetPosition(x, y float32)
  45. SetPositionX(x float32)
  46. SetPositionY(y float32)
  47. }
  48. // Panel is 2D rectangular graphic which by default has a quad (2 triangles) geometry.
  49. // When using the default geometry, a panel has margins, borders, paddings
  50. // and a content area. The content area can be associated with a texture
  51. // It is the building block of most GUI widgets.
  52. type Panel struct {
  53. *graphic.Graphic // Embedded graphic
  54. mat *material.Material // panel material
  55. bounded bool // Whether panel is bounded by its parent
  56. enabled bool // Whether event should be processed for this panel
  57. focusable bool // Whether panel can be focused on mouse down (so it receives key events)
  58. layout ILayout // current layout for children
  59. layoutParams interface{} // current layout parameters used by container panel
  60. marginSizes RectBounds // external margin sizes in pixel coordinates
  61. borderSizes RectBounds // border sizes in pixel coordinates
  62. paddingSizes RectBounds // padding sizes in pixel coordinates
  63. content Rect // current content rectangle in pixel coordinates
  64. // Absolute screen position and external size in pixels
  65. pospix math32.Vector3
  66. width float32
  67. height float32
  68. // Absolute screen position and size in clip (NDC) coordinates
  69. posclip math32.Vector3
  70. wclip float32
  71. hclip float32
  72. xmin float32 // minimum absolute x this panel can use
  73. xmax float32 // maximum absolute x this panel can use
  74. ymin float32 // minimum absolute y this panel can use
  75. ymax float32 // maximum absolute y this panel can use
  76. // Uniforms sent to shader
  77. uniMatrix gls.Uniform // model matrix uniform location cache
  78. uniPanel gls.Uniform // panel parameters uniform location cache
  79. udata struct { // Combined uniform data 8 * vec4
  80. bounds math32.Vector4 // panel bounds in texture coordinates
  81. borders math32.Vector4 // panel borders in texture coordinates
  82. paddings math32.Vector4 // panel paddings in texture coordinates
  83. content math32.Vector4 // panel content area in texture coordinates
  84. bordersColor math32.Color4 // panel border color
  85. paddingsColor math32.Color4 // panel padding color
  86. contentColor math32.Color4 // panel content color
  87. textureValid float32 // texture valid flag (bool)
  88. dummy [3]float32 // complete 8 * vec4
  89. }
  90. }
  91. // PanelStyle contains all the styling attributes of a Panel.
  92. type PanelStyle struct {
  93. Margin RectBounds
  94. Border RectBounds
  95. Padding RectBounds
  96. BorderColor math32.Color4
  97. BgColor math32.Color4
  98. }
  99. // BasicStyle extends PanelStyle by adding a foreground color.
  100. // Many GUI components can be styled using BasicStyle or redeclared versions thereof (e.g. ButtonStyle)
  101. type BasicStyle struct {
  102. PanelStyle
  103. FgColor math32.Color4
  104. }
  105. const (
  106. deltaZ = -0.000001 // delta Z for bounded panels
  107. deltaZunb = deltaZ * 10000 // delta Z for unbounded panels
  108. )
  109. // Quad geometry shared by ALL Panels
  110. var panelQuadGeometry *geometry.Geometry
  111. // NewPanel creates and returns a pointer to a new panel with the
  112. // specified dimensions in pixels and a default quad geometry
  113. func NewPanel(width, height float32) *Panel {
  114. p := new(Panel)
  115. p.Initialize(p, width, height)
  116. return p
  117. }
  118. // Initialize initializes this panel and is normally used by other types which embed a panel.
  119. func (p *Panel) Initialize(ipan IPanel, width, height float32) { // TODO rename to Init
  120. p.width = width
  121. p.height = height
  122. // If first time, create panel quad geometry
  123. if panelQuadGeometry == nil {
  124. // Builds array with vertex positions and texture coordinates
  125. positions := math32.NewArrayF32(0, 20)
  126. positions.Append(
  127. 0, 0, 0, 0, 1,
  128. 0, -1, 0, 0, 0,
  129. 1, -1, 0, 1, 0,
  130. 1, 0, 0, 1, 1,
  131. )
  132. // Builds array of indices
  133. indices := math32.NewArrayU32(0, 6)
  134. indices.Append(0, 1, 2, 0, 2, 3)
  135. // Creates geometry
  136. geom := geometry.NewGeometry()
  137. geom.SetIndices(indices)
  138. geom.AddVBO(gls.NewVBO(positions).
  139. AddAttrib(gls.VertexPosition).
  140. AddAttrib(gls.VertexTexcoord),
  141. )
  142. panelQuadGeometry = geom
  143. }
  144. // Initialize material
  145. p.mat = material.NewMaterial()
  146. p.mat.SetShader("panel")
  147. p.mat.SetShaderUnique(true)
  148. // Initialize graphic
  149. p.Graphic = graphic.NewGraphic(ipan, panelQuadGeometry.Incref(), gls.TRIANGLES)
  150. p.AddMaterial(p, p.mat, 0, 0)
  151. // Initialize uniforms location caches
  152. p.uniMatrix.Init("ModelMatrix")
  153. p.uniPanel.Init("Panel")
  154. // Set defaults
  155. p.udata.bordersColor = math32.Color4{0, 0, 0, 1}
  156. p.bounded = true
  157. p.enabled = true
  158. p.resize(width, height, true)
  159. // Subscribe to OnDescendant to update Z-positions starting from "root" panels
  160. p.Subscribe(core.OnDescendant, func(evname string, ev interface{}) {
  161. par := p.Parent()
  162. _, parentIsIPanel := par.(IPanel)
  163. if par == nil || !parentIsIPanel {
  164. // This is a "root" panel
  165. p.setZ(0, deltaZunb)
  166. }
  167. })
  168. }
  169. // InitializeGraphic initializes this panel with a different graphic
  170. func (p *Panel) InitializeGraphic(width, height float32, gr *graphic.Graphic) {
  171. p.Graphic = gr
  172. p.width = width
  173. p.height = height
  174. // Initializes uniforms location caches
  175. p.uniMatrix.Init("ModelMatrix")
  176. p.uniPanel.Init("Panel")
  177. // Set defaults
  178. p.udata.bordersColor = math32.Color4{0, 0, 0, 1}
  179. p.bounded = true
  180. p.enabled = true
  181. p.resize(width, height, true)
  182. }
  183. // GetPanel satisfies the IPanel interface and
  184. // returns pointer to this panel
  185. func (p *Panel) GetPanel() *Panel {
  186. return p
  187. }
  188. // Material returns a pointer for this panel's Material
  189. func (p *Panel) Material() *material.Material { // TODO remove - allow for setting and getting a single texture
  190. return p.mat
  191. }
  192. // SetTopChild sets the Z coordinate of the specified panel to
  193. // be on top of all other children of this panel.
  194. // The function does not check if the specified panel is a
  195. // child of this one.
  196. func (p *Panel) SetTopChild(ipan IPanel) {
  197. // Remove panel and if found appends to the end
  198. found := p.Remove(ipan)
  199. if found {
  200. p.Add(ipan)
  201. p.SetChanged(true)
  202. }
  203. }
  204. // SetPosition sets this panel absolute position in pixel coordinates
  205. // from left to right and from top to bottom of the screen.
  206. func (p *Panel) SetPosition(x, y float32) {
  207. p.Node.SetPositionX(math32.Round(x))
  208. p.Node.SetPositionY(math32.Round(y))
  209. }
  210. // SetSize sets this panel external width and height in pixels.
  211. func (p *Panel) SetSize(width, height float32) {
  212. if width < 0 {
  213. log.Warn("Invalid panel width:%v", width)
  214. width = 0
  215. }
  216. if height < 0 {
  217. log.Warn("Invalid panel height:%v", height)
  218. height = 0
  219. }
  220. p.resize(width, height, true)
  221. }
  222. // SetWidth sets this panel external width in pixels.
  223. // The internal panel areas and positions are recalculated
  224. func (p *Panel) SetWidth(width float32) {
  225. p.SetSize(width, p.height)
  226. }
  227. // SetHeight sets this panel external height in pixels.
  228. // The internal panel areas and positions are recalculated
  229. func (p *Panel) SetHeight(height float32) {
  230. p.SetSize(p.width, height)
  231. }
  232. // SetContentAspectWidth sets the width of the content area of the panel
  233. // to the specified value and adjusts its height to keep the same aspect radio.
  234. func (p *Panel) SetContentAspectWidth(width float32) {
  235. aspect := p.content.Width / p.content.Height
  236. height := width / aspect
  237. p.SetContentSize(width, height)
  238. }
  239. // SetContentAspectHeight sets the height of the content area of the panel
  240. // to the specified value and adjusts its width to keep the same aspect ratio.
  241. func (p *Panel) SetContentAspectHeight(height float32) {
  242. aspect := p.content.Width / p.content.Height
  243. width := height / aspect
  244. p.SetContentSize(width, height)
  245. }
  246. // Size returns this panel current external width and height in pixels
  247. func (p *Panel) Size() (float32, float32) {
  248. return p.width, p.height
  249. }
  250. // Width returns the current panel external width in pixels
  251. func (p *Panel) Width() float32 {
  252. return p.width
  253. }
  254. // Height returns the current panel external height in pixels
  255. func (p *Panel) Height() float32 {
  256. return p.height
  257. }
  258. // ContentWidth returns the current width of the content area in pixels
  259. func (p *Panel) ContentWidth() float32 {
  260. return p.content.Width
  261. }
  262. // ContentHeight returns the current height of the content area in pixels
  263. func (p *Panel) ContentHeight() float32 {
  264. return p.content.Height
  265. }
  266. // SetMargins set this panel margin sizes in pixels
  267. // and recalculates the panel external size
  268. func (p *Panel) SetMargins(top, right, bottom, left float32) {
  269. p.marginSizes.Set(top, right, bottom, left)
  270. p.resize(p.calcWidth(), p.calcHeight(), true)
  271. }
  272. // SetMarginsFrom sets this panel margins sizes from the specified
  273. // RectBounds pointer and recalculates the panel external size
  274. func (p *Panel) SetMarginsFrom(src *RectBounds) {
  275. p.marginSizes = *src
  276. p.resize(p.calcWidth(), p.calcHeight(), true)
  277. }
  278. // Margins returns the current margin sizes in pixels
  279. func (p *Panel) Margins() RectBounds {
  280. return p.marginSizes
  281. }
  282. // SetBorders sets this panel border sizes in pixels
  283. // and recalculates the panel external size
  284. func (p *Panel) SetBorders(top, right, bottom, left float32) {
  285. p.borderSizes.Set(top, right, bottom, left)
  286. p.resize(p.calcWidth(), p.calcHeight(), true)
  287. }
  288. // SetBordersFrom sets this panel border sizes from the specified
  289. // RectBounds pointer and recalculates the panel size
  290. func (p *Panel) SetBordersFrom(src *RectBounds) {
  291. p.borderSizes = *src
  292. p.resize(p.calcWidth(), p.calcHeight(), true)
  293. }
  294. // Borders returns this panel current border sizes
  295. func (p *Panel) Borders() RectBounds {
  296. return p.borderSizes
  297. }
  298. // SetPaddings sets the panel padding sizes in pixels
  299. func (p *Panel) SetPaddings(top, right, bottom, left float32) {
  300. p.paddingSizes.Set(top, right, bottom, left)
  301. p.resize(p.calcWidth(), p.calcHeight(), true)
  302. }
  303. // SetPaddingsFrom sets this panel padding sizes from the specified
  304. // RectBounds pointer and recalculates the panel size
  305. func (p *Panel) SetPaddingsFrom(src *RectBounds) {
  306. p.paddingSizes = *src
  307. p.resize(p.calcWidth(), p.calcHeight(), true)
  308. }
  309. // Paddings returns this panel padding sizes in pixels
  310. func (p *Panel) Paddings() RectBounds {
  311. return p.paddingSizes
  312. }
  313. // SetBordersColor sets the color of this panel borders
  314. // The borders opacity is set to 1.0 (full opaque)
  315. func (p *Panel) SetBordersColor(color *math32.Color) {
  316. p.udata.bordersColor = math32.Color4{color.R, color.G, color.B, 1}
  317. p.SetChanged(true)
  318. }
  319. // SetBordersColor4 sets the color and opacity of this panel borders
  320. func (p *Panel) SetBordersColor4(color *math32.Color4) {
  321. p.udata.bordersColor = *color
  322. p.SetChanged(true)
  323. }
  324. // BordersColor4 returns current border color
  325. func (p *Panel) BordersColor4() math32.Color4 {
  326. return p.udata.bordersColor
  327. }
  328. // SetPaddingsColor sets the color of this panel paddings.
  329. func (p *Panel) SetPaddingsColor(color *math32.Color) {
  330. p.udata.paddingsColor = math32.Color4{color.R, color.G, color.B, 1}
  331. p.SetChanged(true)
  332. }
  333. // SetColor sets the color of the panel paddings and content area
  334. func (p *Panel) SetColor(color *math32.Color) *Panel {
  335. p.udata.paddingsColor = math32.Color4{color.R, color.G, color.B, 1}
  336. p.udata.contentColor = p.udata.paddingsColor
  337. p.SetChanged(true)
  338. return p
  339. }
  340. // SetColor4 sets the color of the panel paddings and content area
  341. func (p *Panel) SetColor4(color *math32.Color4) *Panel {
  342. p.udata.paddingsColor = *color
  343. p.udata.contentColor = *color
  344. p.SetChanged(true)
  345. return p
  346. }
  347. // Color4 returns the current color of the panel content area
  348. func (p *Panel) Color4() math32.Color4 {
  349. return p.udata.contentColor
  350. }
  351. // ApplyStyle applies the provided PanelStyle to the panel
  352. func (p *Panel) ApplyStyle(ps *PanelStyle) {
  353. p.udata.bordersColor = ps.BorderColor
  354. p.udata.paddingsColor = ps.BgColor
  355. p.udata.contentColor = ps.BgColor
  356. p.marginSizes = ps.Margin
  357. p.borderSizes = ps.Border
  358. p.paddingSizes = ps.Padding
  359. p.resize(p.calcWidth(), p.calcHeight(), true)
  360. }
  361. // SetContentSize sets this panel content size to the specified dimensions.
  362. // The external size of the panel may increase or decrease to acomodate
  363. // the new content size.
  364. func (p *Panel) SetContentSize(width, height float32) {
  365. p.setContentSize(width, height, true)
  366. }
  367. // SetContentWidth sets this panel content width to the specified dimension in pixels.
  368. // The external size of the panel may increase or decrease to accommodate the new width
  369. func (p *Panel) SetContentWidth(width float32) {
  370. p.SetContentSize(width, p.content.Height)
  371. }
  372. // SetContentHeight sets this panel content height to the specified dimension in pixels.
  373. // The external size of the panel may increase or decrease to accommodate the new width
  374. func (p *Panel) SetContentHeight(height float32) {
  375. p.SetContentSize(p.content.Width, height)
  376. }
  377. // MinWidth returns the minimum width of this panel (ContentWidth = 0)
  378. func (p *Panel) MinWidth() float32 {
  379. return p.paddingSizes.Left + p.paddingSizes.Right +
  380. p.borderSizes.Left + p.borderSizes.Right +
  381. p.marginSizes.Left + p.marginSizes.Right
  382. }
  383. // MinHeight returns the minimum height of this panel (ContentHeight = 0)
  384. func (p *Panel) MinHeight() float32 {
  385. return p.paddingSizes.Top + p.paddingSizes.Bottom +
  386. p.borderSizes.Top + p.borderSizes.Bottom +
  387. p.marginSizes.Top + p.marginSizes.Bottom
  388. }
  389. // Pospix returns this panel absolute coordinate in pixels
  390. func (p *Panel) Pospix() math32.Vector3 {
  391. return p.pospix
  392. }
  393. // Add adds a child panel to this one
  394. // TODO DOC This overrides Node because only IPanels can be children of an IPanel
  395. func (p *Panel) Add(ichild IPanel) *Panel {
  396. p.Node.Add(ichild)
  397. if p.layout != nil {
  398. p.layout.Recalc(p)
  399. }
  400. return p
  401. }
  402. // Remove removes the specified child from this panel
  403. func (p *Panel) Remove(ichild IPanel) bool {
  404. res := p.Node.Remove(ichild)
  405. if res {
  406. if p.layout != nil {
  407. p.layout.Recalc(p)
  408. }
  409. }
  410. return res
  411. }
  412. // Bounded returns this panel bounded state
  413. func (p *Panel) Bounded() bool {
  414. return p.bounded
  415. }
  416. // SetBounded sets this panel bounded state
  417. func (p *Panel) SetBounded(bounded bool) {
  418. p.bounded = bounded
  419. p.SetChanged(true)
  420. }
  421. // UpdateMatrixWorld overrides the standard core.Node version which is called by
  422. // the Engine before rendering the frame.
  423. func (p *Panel) UpdateMatrixWorld() {
  424. par := p.Parent()
  425. if par == nil {
  426. p.updateBounds(nil)
  427. // Panel has parent
  428. } else {
  429. parpan, ok := par.(IPanel)
  430. if ok {
  431. p.updateBounds(parpan.GetPanel())
  432. } else {
  433. p.updateBounds(nil)
  434. }
  435. }
  436. // Update this panel children
  437. for _, ichild := range p.Children() {
  438. ichild.UpdateMatrixWorld()
  439. }
  440. }
  441. // ContainsPosition returns indication if this panel contains
  442. // the specified screen position in pixels.
  443. func (p *Panel) ContainsPosition(x, y float32) bool {
  444. if x < p.pospix.X || x >= (p.pospix.X+p.width) {
  445. return false
  446. }
  447. if y < p.pospix.Y || y >= (p.pospix.Y+p.height) {
  448. return false
  449. }
  450. return true
  451. }
  452. // InsideBorders returns indication if the specified screen
  453. // position in pixels is inside the panel borders, including the borders width.
  454. // Unlike "ContainsPosition" is does not consider the panel margins.
  455. func (p *Panel) InsideBorders(x, y float32) bool {
  456. if x < (p.pospix.X+p.marginSizes.Left) || x >= (p.pospix.X+p.width-p.marginSizes.Right) ||
  457. y < (p.pospix.Y+p.marginSizes.Top) || y >= (p.pospix.Y+p.height-p.marginSizes.Bottom) {
  458. return false
  459. }
  460. return true
  461. }
  462. // Intersects returns if this panel intersects with the other panel
  463. func (p *Panel) Intersects(other *Panel) bool {
  464. // Checks if one panel is completely on the left side of the other
  465. if p.pospix.X+p.width <= other.pospix.X || other.pospix.X+other.width <= p.pospix.X {
  466. return false
  467. }
  468. // Checks if one panel is completely above the other
  469. if p.pospix.Y+p.height <= other.pospix.Y || other.pospix.Y+other.height <= p.pospix.Y {
  470. return false
  471. }
  472. return true
  473. }
  474. // SetEnabled sets the panel enabled state
  475. // A disabled panel do not process key or mouse events.
  476. func (p *Panel) SetEnabled(state bool) {
  477. p.enabled = state
  478. p.Dispatch(OnEnable, nil)
  479. }
  480. // Enabled returns the current enabled state of this panel
  481. func (p *Panel) Enabled() bool {
  482. return p.enabled
  483. }
  484. // SetLayout sets the layout to use to position the children of this panel
  485. // To remove the layout, call this function passing nil as parameter.
  486. func (p *Panel) SetLayout(ilayout ILayout) {
  487. p.layout = ilayout
  488. if p.layout != nil {
  489. p.layout.Recalc(p)
  490. }
  491. }
  492. // Layout returns this panel current layout
  493. func (p *Panel) Layout() ILayout {
  494. return p.layout
  495. }
  496. // SetLayoutParams sets the layout parameters for this panel
  497. func (p *Panel) SetLayoutParams(params interface{}) {
  498. p.layoutParams = params
  499. }
  500. // LayoutParams returns this panel current layout parameters
  501. func (p *Panel) LayoutParams() interface{} {
  502. return p.layoutParams
  503. }
  504. // ContentCoords converts the specified window absolute coordinates in pixels
  505. // (as informed by OnMouse event) to this panel internal content area pixel coordinates
  506. func (p *Panel) ContentCoords(wx, wy float32) (float32, float32) {
  507. cx := wx - p.pospix.X -
  508. p.paddingSizes.Left -
  509. p.borderSizes.Left -
  510. p.marginSizes.Left
  511. cy := wy - p.pospix.Y -
  512. p.paddingSizes.Top -
  513. p.borderSizes.Top -
  514. p.marginSizes.Top
  515. return cx, cy
  516. }
  517. // NDC2Pix converts the specified NDC coordinates (-1,1) to relative pixel coordinates
  518. // for this panel content area.
  519. // 0,0 1,0 0,0 w,0
  520. // +--------+ +---------+
  521. // | | -------> | |
  522. // +--------+ +---------+
  523. // 0,-1 1,-1 0,h w,h
  524. func (p *Panel) NDC2Pix(nx, ny float32) (x, y float32) {
  525. w := p.ContentWidth()
  526. h := p.ContentHeight()
  527. return w * nx, -h * ny
  528. }
  529. // Pix2NDC converts the specified relative pixel coordinates to NDC coordinates for this panel
  530. // content area
  531. // 0,0 w,0 0,0 1,0
  532. // +---------+ +---------+
  533. // | | ------> | |
  534. // +---------+ +---------+
  535. // 0,h w,h 0,-1 1,-1
  536. func (p *Panel) Pix2NDC(px, py float32) (nx, ny float32) {
  537. w := p.ContentWidth()
  538. h := p.ContentHeight()
  539. return px / w, -py / h
  540. }
  541. // setContentSize is an internal version of SetContentSize() which allows
  542. // to determine if the panel will recalculate its layout and dispatch event.
  543. // It is normally used by layout managers when setting the panel content size
  544. // to avoid another invokation of the layout manager.
  545. func (p *Panel) setContentSize(width, height float32, dispatch bool) {
  546. // Calculates the new desired external width and height
  547. eWidth := width +
  548. p.paddingSizes.Left + p.paddingSizes.Right +
  549. p.borderSizes.Left + p.borderSizes.Right +
  550. p.marginSizes.Left + p.marginSizes.Right
  551. eHeight := height +
  552. p.paddingSizes.Top + p.paddingSizes.Bottom +
  553. p.borderSizes.Top + p.borderSizes.Bottom +
  554. p.marginSizes.Top + p.marginSizes.Bottom
  555. p.resize(eWidth, eHeight, dispatch)
  556. }
  557. // setZ sets the Z coordinate for this panel and its children recursively
  558. // starting at the specified z and zunb coordinates.
  559. // The z coordinate is used for bound panels and zunb for unbounded panels.
  560. // The z coordinate is set so panels added later are closer to the screen.
  561. // All unbounded panels and its children are closer than any of the bounded panels.
  562. func (p *Panel) setZ(z, zunb float32) (float32, float32) {
  563. // TODO there's a problem here - two buttons with labels one on top of the other have interlacing labels...
  564. // Bounded panel
  565. if p.bounded {
  566. p.SetPositionZ(z)
  567. z += deltaZ
  568. for _, ichild := range p.Children() {
  569. z, zunb = ichild.(IPanel).GetPanel().setZ(z, zunb)
  570. }
  571. return z, zunb
  572. }
  573. // Unbounded panel
  574. p.SetPositionZ(zunb)
  575. zchild := zunb + deltaZ
  576. zunb += deltaZunb
  577. for _, ichild := range p.Children() {
  578. _, zunb = ichild.(IPanel).GetPanel().setZ(zchild, zunb)
  579. }
  580. return z, zunb
  581. }
  582. // updateBounds is called by UpdateMatrixWorld() and calculates this panel
  583. // bounds considering the bounds of its parent
  584. func (p *Panel) updateBounds(par *Panel) {
  585. // If this panel has no parent, its pixel position is its Position
  586. if par == nil {
  587. p.pospix.X = p.Position().X
  588. p.pospix.Y = p.Position().Y
  589. // If this panel is bounded to its parent, its coordinates are relative
  590. // to the parent internal content rectangle.
  591. } else if p.bounded {
  592. p.pospix.X = p.Position().X + par.pospix.X + par.marginSizes.Left + par.borderSizes.Left + par.paddingSizes.Left
  593. p.pospix.Y = p.Position().Y + par.pospix.Y + par.marginSizes.Top + par.borderSizes.Top + par.paddingSizes.Top
  594. // Otherwise its coordinates are relative to the parent outer coordinates.
  595. } else {
  596. p.pospix.X = p.Position().X + par.pospix.X
  597. p.pospix.Y = p.Position().Y + par.pospix.Y
  598. }
  599. // Maximum x,y coordinates for this panel
  600. p.xmin = p.pospix.X
  601. p.ymin = p.pospix.Y
  602. p.xmax = p.pospix.X + p.width
  603. p.ymax = p.pospix.Y + p.height
  604. // Set default bounds to be entire panel texture
  605. p.udata.bounds = math32.Vector4{0, 0, 1, 1}
  606. // If this panel has no parent or is unbounded then the default bounds are correct
  607. if par == nil || !p.bounded {
  608. return
  609. }
  610. // From here on panel has parent and is bounded by parent
  611. // TODO why not use par.xmin, etc here ? shouldn't they be already updated?
  612. // Get the parent content area minimum and maximum absolute coordinates in pixels
  613. pxmin := par.pospix.X + par.marginSizes.Left + par.borderSizes.Left + par.paddingSizes.Left
  614. if pxmin < par.xmin {
  615. pxmin = par.xmin
  616. }
  617. pymin := par.pospix.Y + par.marginSizes.Top + par.borderSizes.Top + par.paddingSizes.Top
  618. if pymin < par.ymin {
  619. pymin = par.ymin
  620. }
  621. pxmax := par.pospix.X + par.width - (par.marginSizes.Right + par.borderSizes.Right + par.paddingSizes.Right)
  622. if pxmax > par.xmax {
  623. pxmax = par.xmax
  624. }
  625. pymax := par.pospix.Y + par.height - (par.marginSizes.Bottom + par.borderSizes.Bottom + par.paddingSizes.Bottom)
  626. if pymax > par.ymax {
  627. pymax = par.ymax
  628. }
  629. // Update this panel minimum x and y coordinates.
  630. if p.xmin < pxmin {
  631. p.xmin = pxmin
  632. }
  633. if p.ymin < pymin {
  634. p.ymin = pymin
  635. }
  636. // Update this panel maximum x and y coordinates.
  637. if p.xmax > pxmax {
  638. p.xmax = pxmax
  639. }
  640. if p.ymax > pymax {
  641. p.ymax = pymax
  642. }
  643. // If this panel is bounded to its parent, calculates the bounds
  644. // for clipping in texture coordinates
  645. if p.pospix.X < p.xmin {
  646. p.udata.bounds.X = (p.xmin - p.pospix.X) / p.width
  647. }
  648. if p.pospix.Y < p.ymin {
  649. p.udata.bounds.Y = (p.ymin - p.pospix.Y) / p.height
  650. }
  651. if p.pospix.X+p.width > p.xmax {
  652. p.udata.bounds.Z = (p.xmax - p.pospix.X) / p.width
  653. }
  654. if p.pospix.Y+p.height > p.ymax {
  655. p.udata.bounds.W = (p.ymax - p.pospix.Y) / p.height
  656. }
  657. }
  658. // calcWidth calculates the panel external width in pixels
  659. func (p *Panel) calcWidth() float32 {
  660. return p.content.Width +
  661. p.paddingSizes.Left + p.paddingSizes.Right +
  662. p.borderSizes.Left + p.borderSizes.Right +
  663. p.marginSizes.Left + p.marginSizes.Right
  664. }
  665. // calcHeight calculates the panel external height in pixels
  666. func (p *Panel) calcHeight() float32 {
  667. return p.content.Height +
  668. p.paddingSizes.Top + p.paddingSizes.Bottom +
  669. p.borderSizes.Top + p.borderSizes.Bottom +
  670. p.marginSizes.Top + p.marginSizes.Bottom
  671. }
  672. // resize tries to set the external size of the panel to the specified
  673. // dimensions and recalculates the size and positions of the internal areas.
  674. // The margins, borders and padding sizes are kept and the content
  675. // area size is adjusted. So if the panel is decreased, its minimum
  676. // size is determined by the margins, borders and paddings.
  677. // Normally it should be called with dispatch=true to recalculate the
  678. // panel layout and dispatch OnSize event.
  679. func (p *Panel) resize(width, height float32, dispatch bool) {
  680. var padding Rect
  681. var border Rect
  682. width = math32.Round(width)
  683. height = math32.Round(height)
  684. // Adjust content width
  685. p.content.Width = width - p.marginSizes.Left - p.marginSizes.Right - p.borderSizes.Left - p.borderSizes.Right - p.paddingSizes.Left - p.paddingSizes.Right
  686. if p.content.Width < 0 {
  687. p.content.Width = 0
  688. }
  689. // Adjusts content height
  690. p.content.Height = height - p.marginSizes.Top - p.marginSizes.Bottom - p.borderSizes.Top - p.borderSizes.Bottom - p.paddingSizes.Top - p.paddingSizes.Bottom
  691. if p.content.Height < 0 {
  692. p.content.Height = 0
  693. }
  694. // Adjust other area widths
  695. padding.Width = p.paddingSizes.Left + p.content.Width + p.paddingSizes.Right
  696. border.Width = p.borderSizes.Left + padding.Width + p.borderSizes.Right
  697. // Adjust other area heights
  698. padding.Height = p.paddingSizes.Top + p.content.Height + p.paddingSizes.Bottom
  699. border.Height = p.borderSizes.Top + padding.Height + p.borderSizes.Bottom
  700. // Set area positions
  701. border.X = p.marginSizes.Left
  702. border.Y = p.marginSizes.Top
  703. padding.X = border.X + p.borderSizes.Left
  704. padding.Y = border.Y + p.borderSizes.Top
  705. p.content.X = padding.X + p.paddingSizes.Left
  706. p.content.Y = padding.Y + p.paddingSizes.Top
  707. // Set final panel dimensions (may be different from requested dimensions)
  708. p.width = p.marginSizes.Left + border.Width + p.marginSizes.Right
  709. p.height = p.marginSizes.Top + border.Height + p.marginSizes.Bottom
  710. // Update border uniform in texture coordinates (0,0 -> 1,1)
  711. p.udata.borders = math32.Vector4{
  712. float32(border.X) / float32(p.width),
  713. float32(border.Y) / float32(p.height),
  714. float32(border.Width) / float32(p.width),
  715. float32(border.Height) / float32(p.height),
  716. }
  717. // Update padding uniform in texture coordinates (0,0 -> 1,1)
  718. p.udata.paddings = math32.Vector4{
  719. float32(padding.X) / float32(p.width),
  720. float32(padding.Y) / float32(p.height),
  721. float32(padding.Width) / float32(p.width),
  722. float32(padding.Height) / float32(p.height),
  723. }
  724. // Update content uniform in texture coordinates (0,0 -> 1,1)
  725. p.udata.content = math32.Vector4{
  726. float32(p.content.X) / float32(p.width),
  727. float32(p.content.Y) / float32(p.height),
  728. float32(p.content.Width) / float32(p.width),
  729. float32(p.content.Height) / float32(p.height),
  730. }
  731. p.SetChanged(true)
  732. // Update layout and dispatch event
  733. if !dispatch {
  734. return
  735. }
  736. if p.layout != nil {
  737. p.layout.Recalc(p)
  738. }
  739. p.Dispatch(OnResize, nil)
  740. }
  741. // RenderSetup is called by the Engine before drawing the object
  742. func (p *Panel) RenderSetup(gl *gls.GLS, rinfo *core.RenderInfo) {
  743. // Sets texture valid flag in uniforms
  744. // depending if the material has texture
  745. if p.mat.TextureCount() > 0 {
  746. p.udata.textureValid = 1
  747. } else {
  748. p.udata.textureValid = 0
  749. }
  750. // Sets model matrix
  751. var mm math32.Matrix4
  752. p.SetModelMatrix(gl, &mm)
  753. // Transfer model matrix uniform
  754. location := p.uniMatrix.Location(gl)
  755. gl.UniformMatrix4fv(location, 1, false, &mm[0])
  756. // Transfer panel parameters combined uniform
  757. location = p.uniPanel.Location(gl)
  758. const vec4count = 8
  759. gl.Uniform4fv(location, vec4count, &p.udata.bounds.X)
  760. }
  761. // SetModelMatrix calculates and sets the specified matrix with the model matrix for this panel
  762. func (p *Panel) SetModelMatrix(gl *gls.GLS, mm *math32.Matrix4) {
  763. // Get scale of window (for HiDPI support)
  764. sX64, sY64 := Manager().win.GetScale()
  765. sX := float32(sX64)
  766. sY := float32(sY64)
  767. // Get the current viewport width and height
  768. _, _, width, height := gl.GetViewport()
  769. fwidth := float32(width) / sX
  770. fheight := float32(height) / sY
  771. // Scale the quad for the viewport so it has fixed dimensions in pixels.
  772. p.wclip = 2 * float32(p.width) / fwidth
  773. p.hclip = 2 * float32(p.height) / fheight
  774. var scale math32.Vector3
  775. scale.Set(p.wclip, p.hclip, 1)
  776. // Convert absolute position in pixel coordinates from the top/left to
  777. // standard OpenGL clip coordinates of the quad center
  778. p.posclip.X = (p.pospix.X - fwidth/2) / (fwidth / 2)
  779. p.posclip.Y = -(p.pospix.Y - fheight/2) / (fheight / 2)
  780. p.posclip.Z = p.Position().Z
  781. // Calculates the model matrix
  782. var quat math32.Quaternion
  783. quat.SetIdentity()
  784. mm.Compose(&p.posclip, &quat, &scale)
  785. }