This documentation is transcluded from Module:Dimensions/doc. Changes can be proposed in the talk page.
Module:Dimensions is shared across the Star Citizen Wikis.
This module is shared across the Star Citizen Wikis. Any changes should also be relayed to the GitHub repository.
| Function list |
|---|
--- Module:Dimensions
--- Used to display an isometric cube showing the dimensions of an object
---
--- TODO: Add i18n
--- TODO: Brush up isometric functions for more generic use cases
require( 'strict' )
local p = {}
local i18n = require( 'Module:i18n' ):new()
local lang = mw.getContentLanguage()
--- Wrapper function for Module:i18n.translate
---
--- @param key string The translation key
--- @return string If the key was not found, the key is returned
local function t( key )
return i18n:translate( key )
end
--- Get the text HTML object
---
--- @param data table
--- @return mw.html
local function getTextHTML( data )
if not data.label and not data.value then return end
local html = mw.html.create( 'div' )
:addClass( 'template-dimensions-box-text' )
if data.variant then
html:addClass( 'template-dimensions-box-text-' .. data.variant )
end
if data.label then
html:tag( 'div' )
:addClass( 'template-dimensions-label' )
:wikitext( data.label )
:done()
end
if data.value then
html:tag( 'div' )
:addClass( 'template-dimensions-data' )
:wikitext( data.value )
:done()
end
return html
end
--- Get the object HTML object
---
--- @param data table
--- @return mw.html
local function getObjectHTML( data )
local html = mw.html.create( 'div' )
:addClass( 'template-dimensions-object' )
:css( {
[ '--object-length' ] = data.length.number,
[ '--object-width' ] = data.width.number,
[ '--object-height' ] = data.height.number,
} )
local isometric = html:tag( 'div' )
:addClass( 'template-dimensions-isometric' )
:css( {
[ 'transform-style' ] = 'preserve-3d',
[ 'grid-template-areas' ] = "'layer'"
} )
-- Top layer
isometric:tag( 'div' )
:addClass( 'template-dimensions-layer template-dimensions-layer-top' )
:css( 'transform-style', 'preserve-3d' )
:tag( 'div' )
:addClass( 'template-dimensions-box-faces' )
:css( 'transform-style', 'preserve-3d' )
:tag( 'div' )
:addClass( 'template-dimensions-box-face template-dimensions-box-face-top' )
:done()
:tag( 'div' )
:addClass( 'template-dimensions-box-face template-dimensions-box-face-front' )
:done()
:tag( 'div' )
:addClass( 'template-dimensions-box-face template-dimensions-box-face-right' )
:done()
:done()
:node( getTextHTML( {
label = data.mass.label,
value = data.mass.value,
variant = 'z'
} ) )
:done()
-- Mid layer
isometric:tag( 'div' )
:addClass( 'template-dimensions-layer template-dimensions-layer-mid' )
:css( 'transform-style', 'preserve-3d' )
:node( getTextHTML( {
label = data.height.label,
value = data.height.value,
variant = 'y'
} ) )
:done()
-- Bottom layer
isometric:tag( 'div' )
:addClass( 'template-dimensions-layer template-dimensions-layer-bottom' )
:css( 'transform-style', 'preserve-3d' )
--- Create a human-sized object for reference
--- FIXME: Figure out how to do a box properly, haven't done trigonometry in ages...
:tag( 'div' )
:addClass( 'template-dimensions-reference template-dimensions-box-faces' )
:attr( 'title', 'Human for reference' )
:css( 'transform-style', 'preserve-3d' )
:tag( 'div' )
:addClass( 'template-dimensions-box-face template-dimensions-box-face-top' )
:done()
:tag( 'div' )
:addClass( 'template-dimensions-box-face template-dimensions-box-face-front' )
:done()
--:tag( 'div' )
-- :addClass( 'template-dimensions-box-face template-dimensions-box-face-right' )
-- :done()
:done()
:node( getTextHTML( {
label = data.length.label,
value = data.length.value,
variant = 'z'
} ) )
:node( getTextHTML( {
label = data.width.label,
value = data.width.value,
variant = 'x'
} ) )
:done()
return html
end
--- Get the output HTML object
---
--- @param data table
--- @return mw.html
local function getOutputHTML( data )
local html = mw.html.create( 'div' )
:addClass( 'template-dimensions' )
:node( getObjectHTML( data ) )
return html
end
--- Format arguments into data used by HTML functions
---
--- @param args table
--- @return table|nil
local function getDimensionsData( args )
local lengthNum = tonumber( args.length )
local widthNum = tonumber( args.width )
local heightNum = tonumber( args.height )
if not lengthNum or not widthNum or not heightNum then return end
-- TODO: Make this cleaner by using another table to map the units?
local lengthValue = lang:formatNum( lengthNum ) .. ' m'
local widthValue = lang:formatNum( widthNum ) .. ' m'
local heightValue = lang:formatNum( heightNum ) .. ' m'
-- Mass is optional
local massValue
if args.mass then
local massNum = tonumber( args.mass )
if massNum then
massValue = lang:formatNum( massNum ) .. ' kg'
else
massValue = '-'
end
end
-- TODO: Perhaps this can be done in a loop
local data = {
length = {
number = lengthNum,
label = 'Length',
value = lengthValue
},
width = {
number = widthNum,
label = 'Width',
value = widthValue
},
height = {
number = heightNum,
label = 'Height',
value = heightValue
},
mass = {
label = 'Mass',
value = massValue
}
}
return data
end
--- Lua entry point
---
--- @param args table
--- @param frame table
--- @return string|nil
function p._main( args, frame )
if not args.length or not args.width or not args.height then return end
-- Frame object can be missing if function is invoked from Lua
frame = frame or mw.getCurrentFrame()
local data = getDimensionsData( args )
if not data then return end
return tostring( getOutputHTML( data ) ) .. frame:extensionTag {
name = 'templatestyles', args = { src = 'Module:Dimensions/styles.css' }
}
end
--- Wikitext entry point
---
--- @return string|nil
function p.main( frame )
local args = require( 'Module:Arguments' ).getArgs( frame )
return p._main( args, frame )
end
return p