panel.go 28 KB

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