Parameters for Sinks and Taps

 

This table contains all the possible or required parameters to set up sinks and taps in the Kitchen applications (3DCloud, Assembly Editor).

➡️ See the tutorial Set Up Sinks and Taps for a concrete case on the use of parameters in 3DCloud and Assembly Editor.

Mandatory Parameters

The following parameters are mandatory and must be set for a sink or a tap.

Name	Type	Default Value	Possible Values	Visible	Function
width	real	–	[0 ;∞]	any	Defines the product size of the model on the X-axis (from left to right).
depth	real	–	[0 ;∞]	any	Defines the product size of the model on the Y-axis (from front to back).
height	real	–	[0 ;∞]	any	Defines the product size of the model on the Z-axis (from bottom to top).

Optional Parameters

Reserved names

The following parameters are optional and the name of the parameter are reserved words (can not be modified). To set up these parameters you should use the exact name of the parameter.

Sink Type Products

Name	Type	Default Value	Possible Values	Visible	Function
addDrainerGrooves	boolean	–	TRUE / FALSE	any	Defines whether the sink can have attached drainer grooves.
drainerGrooves	product	–	TRUE / FALSE	any	Defines the drainer grooves product. Requires the addDrainerGrooves parameter.
drainerGroovesPosition	integer	–	[1, 2]	any	Defines the drainer grooves position. Possible values are 1 and 2, representing left and right. Requires the addDrainerGrooves parameter.
isFullDepth	boolean	–	TRUE / FALSE	any	Must be true if the sink is full depth.
fullDepthCutWidth	real	–	[0;∞]	any	Defines the width on which there is no worktop. If not defined, the width of the sink is used instead.
fullDepthThicknessCompatibility	real	–	[0;∞]	any	Defines the list (or range) of the compatible worktop thickness on the left and right of the sink. It is used in the FullDepthSinkThickness
sinkBowlCenterX	real	–	[-∞;∞]	any	Defines the position of the bowls on the X-axis. If numberOfBowls=2, this value is centered on the bowl set.
sinkBowlCenterY	real	–	[-∞;∞]	any	Defines the position of the bowls on the Y-axis. If numberOfBowls=2, this value is centered on the bowl set.

Recommended names

The following parameters are optional and the name of the parameter are recommended (can be modified). To set up these parameters you can chose whatever the name you want.

Tap Type Products

Name	Type	Default Value	Possible Values	Visible	Function
cutOutDiameter	real	–	[0 ;∞]	any	Defines the cut-out diameter that is required for each tap.
xOffset	real	–	[-∞; ∞]	any	Defines the distance between the origin of the BM3 (center of the bounding box) and the center of the tap pipe on the X-axis.
yOffset	real	–	[-∞; ∞]	any	Defines the distance between the origin of the BM3 (center of the bounding box) and the center of the tap pipe on the Y-axis.

Sink Type Products

Name	Type	Default Value	Possible Values	Visible	Function
numberOfBowls	integer	2	1/2	any	Defines the number of bowls for a sink. This parameter is used in sink assemblies to impact number of lids.
sinkThick	real	–	[-∞;∞]	any	Defines the size of the visible part of the sink on the top of the worktop. This thickness parameter is used to define the position of the sink into a cabinet.
xTapOffset	real	–	[-∞;∞]	any	Defines the position of the tap on the X-axis. Necessary even if the tap is outside the sink.
yTapOffset	real	–	[-∞;∞]	any	Defines the position of the tap on the Y-axis. Necessary even if the tap is outside the sink.
zTapOffset	real	–	[-∞;∞]	any	Defines the position of the tap on the Z-axis. Necessary even if the tap is outside the sink.