Difference between revisions of "Component: Bezel Radiused (Advanced Shapes)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
+
{| style="width:50%"
 
 
{| width="50%"
 
 
|-
 
|-
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
| 1.2 (Release)
+
| 1.2
 
|-
 
|-
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Advanced Shapes
 
| Advanced Shapes
 
|}
 
|}
  
  
 +
==Bezel Radiused component==
 +
A purely cosmetic component for creating smoothly radiused bezel or frame to fit around  other components, or to define the edges of panel sections.
  
==[[File:Component Icon d497dced_8e07_49d5_a9f9_4e67c43cb186.png|Image]] Bezel Radiused component==
+
==Component Pack==
A purely cosmetic component for creating smoothly radiused bezel or frame to fit around
 
other components, or to define the edges of panel sections.
 
  
==Examples==
+
FREE
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
==Downloadable macro reference==
 
  
''This component does not contain any downloadable macros''
 
  
==Simulation macro reference==
+
''No detailed description exists yet for this component''
  
===<span style="font-weight: normal;"><u><tt>GetLidPosition</tt></u></span>===
+
==Examples==
Get the position for a plane that will fill the top of the bezel at the highest
 
  
point of the curve.
 
  
'''Parameters'''
 
  
:''This macro has no parameters''
 
  
 +
''<span style="color:red;">No additional examples</span>''
  
'''Return value'''
 
  
:[[Variable Types|HANDLE]]
+
==Downloadable macro reference==
  
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLidPosition'''
 +
|-
 +
| colspan="2" | Get the position for a plane that will fill the top of the bezel at the highest point of the curve.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
===<span style="font-weight: normal;"><u><tt>FitOutsideBase</tt></u></span>===
 
Resize and move the bezel so that it fits around a given target object.  The bezel is fitted around the 'base' of the target - i.e. the face of the object's bounding box with the lowest Z-value.
 
  
'''Parameters'''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FitOutsideBase'''
 +
|-
 +
| colspan="2" | Resize and move the bezel so that it fits around a given target object.  The bezel is fitted around the 'base' of the target - i.e. the face of the object's bounding box with the lowest Z-value.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" | The object to fit the bezel around&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
:[[Variable Types|HANDLE]] ''Target''
 
::The object to fit the bezel around
 
  
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FitInsideBase'''
 +
|-
 +
| colspan="2" | Resize and move the bezel so that it fits a given target object.  The bezel is fitted within the 'base' of the target - i.e. the face of the object's bounding box with the lowest Z-value.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" | The object to fit the bezel around&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
'''Return value'''
 
  
:''This call does not return a value''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFillPosition'''
 +
|-
 +
| colspan="2" | Returns the dimensions and position of a plane area that will fill the frame at its base.  The returned position handle could be use, for example, to fit a text box or image within the frame.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
===<span style="font-weight: normal;"><u><tt>FitInsideBase</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Resize and move the bezel so that it fits a given target object.  The bezel is fitted within the 'base' of the target - i.e. the face of the object's bounding box with the lowest Z-value.
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
'''Parameters'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetColor'''
 
+
|-
:[[Variable Types|HANDLE]] ''Target''
+
| colspan="2" | A quick way changing the border color without re-calculating the geometry. NB) Does not change the start-up color set using the Properties pane.&nbsp;
::The object to fit the bezel around
+
|-
 
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
'''Return value'''
+
| width="90%" | Red
 
+
|-
:''This call does not return a value''
+
| colspan="2" | Amount of red in the color.  (0...255)&nbsp;
 
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
===<span style="font-weight: normal;"><u><tt>GetFillPosition</tt></u></span>===
+
| width="90%" | Green
Returns the dimensions and position of a plane area that will fill the frame at its base.  The returned position handle could be use, for example, to fit a text box or image within the frame.
+
|-
 
+
| colspan="2" | Amount of green in the color. (0...255)&nbsp;
'''Parameters'''
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
:''This macro has no parameters''
+
| width="90%" | Blue
 
+
|-
 
+
| colspan="2" | Amount of blue in the color. (0...255)&nbsp;
'''Return value'''
+
|-
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
:[[Variable Types|HANDLE]]
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
+
|}
 
 
===<span style="font-weight: normal;"><u><tt>SetColor</tt></u></span>===
 
A quick way changing the border color without re-calculating the geometry.
 
 
 
NB) Does not change the start-up color set using the Properties pane.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|BYTE]] ''Red''
 
::Amount of red in the color.  (0...255)
 
 
 
:[[Variable Types|BYTE]] ''Green''
 
::Amount of green in the color. (0...255)
 
 
 
:[[Variable Types|BYTE]] ''Blue''
 
::Amount of blue in the color. (0...255)
 
 
 
 
 
'''Return value'''
 
 
 
:''This call does not return a value''
 
  
  
Line 110: Line 128:
  
 
==Property reference==
 
==Property reference==
<span style="font-weight: normal;"><u>Thickness</u></span>
 
  
This property is of type ''Floating point'' and can be referenced with the variable name ''bezel_thick''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
Sets the thickness of the bezel - radius and depth will change proportionally.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
<span style="font-weight: normal;"><u>Margin</u></span>
+
|-
 
+
|-
This property is of type ''Floating point'' and can be referenced with the variable name ''margin''.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance
This property is used when fitting the bezel to another object using the 'Quick Resize' properties or 'Fit' macros.
+
|-
 
+
|-
It sets the distance between the bezel and the fitted object.
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
+
| width="90%" | Thickness
<span style="font-weight: normal;"><u>Color</u></span>
+
|-
 
+
| colspan="2" | Sets the thickness of the bezel - radius and depth will change proportionally.&nbsp;
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''color''.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
Color of the bezel.
+
| width="90%" | Margin
 
+
|-
<span style="font-weight: normal;"><u>Fit Outside</u></span>
+
| colspan="2" | This property is used when fitting the bezel to another object using the 'Quick Resize' properties or 'Fit' macros. It sets the distance between the bezel and the fitted object. &nbsp;
 
+
|-
This property is of type ''Panel object'' and can be referenced with the variable name ''fit_outside''.
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
+
| width="90%" | Color
Select an object from this drop down to fit the bezel around the outside of the object's base.
+
|-
 
+
| colspan="2" | Color of the bezel.&nbsp;
Note that this is a 'momentary operation', the bezel will not follow subsequent changes to the target object.
+
|-
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
<span style="font-weight: normal;"><u>Fit Inside</u></span>
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Quick Resize
 
+
|-
This property is of type ''Panel object'' and can be referenced with the variable name ''fit_inside''.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
Select an object from this drop down to fit the bezel withinf the object's base.
+
| width="90%" | Fit Outside
 
+
|-
Note that this is a 'momentary operation', the bezel will not follow subsequent changes to the target object.
+
| colspan="2" | Select an object from this drop down to fit the bezel around the outside of the object's base. Note that this is a 'momentary operation', the bezel will not follow subsequent changes to the target object.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
 +
| width="90%" | Fit Inside
 +
|-
 +
| colspan="2" | Select an object from this drop down to fit the bezel withinf the object's base. Note that this is a 'momentary operation', the bezel will not follow subsequent changes to the target object.&nbsp;
 +
|}

Latest revision as of 17:19, 9 November 2022

Author Matrix Ltd
Version 1.2
Category Advanced Shapes


Bezel Radiused component

A purely cosmetic component for creating smoothly radiused bezel or frame to fit around other components, or to define the edges of panel sections.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png GetLidPosition
Get the position for a plane that will fill the top of the bezel at the highest point of the curve. 
Fc9-h32-icon.png - HANDLE Return


Fc9-comp-macro.png FitOutsideBase
Resize and move the bezel so that it fits around a given target object. The bezel is fitted around the 'base' of the target - i.e. the face of the object's bounding box with the lowest Z-value. 
Fc9-h32-icon.png - HANDLE Target
The object to fit the bezel around 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png FitInsideBase
Resize and move the bezel so that it fits a given target object. The bezel is fitted within the 'base' of the target - i.e. the face of the object's bounding box with the lowest Z-value. 
Fc9-h32-icon.png - HANDLE Target
The object to fit the bezel around 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetFillPosition
Returns the dimensions and position of a plane area that will fill the frame at its base. The returned position handle could be use, for example, to fit a text box or image within the frame. 
Fc9-h32-icon.png - HANDLE Return


Fc9-comp-macro.png SetColor
A quick way changing the border color without re-calculating the geometry. NB) Does not change the start-up color set using the Properties pane. 
Fc9-u8-icon.png - BYTE Red
Amount of red in the color. (0...255) 
Fc9-u8-icon.png - BYTE Green
Amount of green in the color. (0...255) 
Fc9-u8-icon.png - BYTE Blue
Amount of blue in the color. (0...255) 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Appearance
Fc9-type-15-icon.png Thickness
Sets the thickness of the bezel - radius and depth will change proportionally. 
Fc9-type-15-icon.png Margin
This property is used when fitting the bezel to another object using the 'Quick Resize' properties or 'Fit' macros. It sets the distance between the bezel and the fitted object.  
Fc9-type-2-icon.png Color
Color of the bezel. 
Fc9-conn-icon.png Quick Resize
Fc9-type-17-icon.png Fit Outside
Select an object from this drop down to fit the bezel around the outside of the object's base. Note that this is a 'momentary operation', the bezel will not follow subsequent changes to the target object. 
Fc9-type-17-icon.png Fit Inside
Select an object from this drop down to fit the bezel withinf the object's base. Note that this is a 'momentary operation', the bezel will not follow subsequent changes to the target object.