panel.go 28 KB

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