Skip to main content
CESDK/CE.SDK/Engine/API Reference/Editor

Settings

Get to know the available editor settings in the CreativeEditor SDK.

All keys listed below can be modified through the Editor API. The nested settings inside UBQSettings can be reached via key paths, e.g. page/title/show.

Settings#

CameraClampingSettings#

MemberTypeDefaultDescription
Member
overshootMode
Type
CameraClampingOvershootMode
Default
Reverse
Description
Controls what happens when the clamp area is smaller than the viewport. Center: the clamp area is centered in the viewport. Reverse: the clamp area can move inside the viewport until it hits the edges.

CameraSettings#

MemberTypeDefaultDescription
Member
clamping
Type
CameraClampingSettings: CameraClampingOvershootMode overshootMode
Default
{}
Description
Clamping settings for the camera.

ControlGizmoSettings#

MemberTypeDefaultDescription
Member
showCropHandles
Type
bool
Default
{true}
Description
Whether or not to show the handles to adjust the crop area during crop mode.
Member
showCropScaleHandles
Type
bool
Default
{true}
Description
Whether or not to display the outer handles that scale the full image during crop.
Member
showResizeHandles
Type
bool
Default
{true}
Description
Whether or not to display the non-proportional resize handles (edge handles)
Member
showRotateHandles
Type
bool
Default
{true}
Description
Whether or not to show the rotation handles.
Member
showScaleHandles
Type
bool
Default
{true}
Description
Whether or not to display the proportional scale handles (corner handles)

DebugFlags#

Flags that control debug outputs.

MemberTypeDefaultDescription
Member
showHandlesInteractionArea
Type
bool
Default
{false}
Description
Display the interaction area around the handles.
Member
useDebugMipmaps
Type
bool
Default
false
Description
Enable the use of colored mipmaps to see which mipmap is used.

MouseSettings#

MemberTypeDefaultDescription
Member
enableScroll
Type
bool
Default
true
Description
Whether the engine processes mouse scroll events.
Member
enableZoom
Type
bool
Default
true
Description
Whether the engine processes mouse zoom events.

PageSettings#

MemberTypeDefaultDescription
Member
dimOutOfPageAreas
Type
bool
Default
true
Description
Whether the opacity of the region outside of all pages should be reduced.
Member
innerBorderColor
Type
Color
Default
createRGBColor(0.0, 0.0, 0.0, 0.0)
Description
Color of the inner frame around the page.
Member
marginFillColor
Type
Color
Default
createRGBColor(0.79, 0.12, 0.40, 0.1)
Description
Color of frame around the bleed margin area of the pages.
Member
marginFrameColor
Type
Color
Default
createRGBColor(0.79, 0.12, 0.40, 0.0)
Description
Color filled into the bleed margins of pages.
Member
outerBorderColor
Type
Color
Default
createRGBColor(1.0, 1.0, 1.0, 0.0)
Description
Color of the outer frame around the page.
Member
title
Type
PageTitleSettings(bool show, bool showOnSinglePage, bool showPageTitleTemplate, bool appendPageName, string separator, Color color, string fontFileUri)
Default
``
Description
Page title settings.

PageTitleSettings#

MemberTypeDefaultDescription
Member
appendPageName
Type
bool
Default
true
Description
Whether to append the page name to the title if a page name is set even if the name is not specified in the template or the template is not shown
Member
color
Type
Color
Default
createRGBColor(1., 1., 1.)
Description
Color of page titles visible in preview mode, can change with different themes.
Member
fontFileUri
Type
string
Default
DEFAULT_FONT
Description
Font of page titles.
Member
separator
Type
string
Default
"-"
Description
Title label separator between the page number and the page name.
Member
show
Type
bool
Default
true
Description
Whether to show titles above each page.
Member
showOnSinglePage
Type
bool
Default
true
Description
Whether to hide the the page title when only a single page is given.
Member
showPageTitleTemplate
Type
bool
Default
true
Description
Whether to include the default page title from page.titleTemplate

PlaceholderControlsSettings#

MemberTypeDefaultDescription
Member
showButton
Type
bool
Default
true
Description
Show the placeholder button.
Member
showOverlay
Type
bool
Default
true
Description
Show the overlay pattern.

Settings#

MemberTypeDefaultDescription
Member
alwaysHighlightPlaceholders
Type
bool
Default
false
Description
Whether placeholder elements should always be highlighted in the scene.
Member
basePath
Type
string
Default
""
Description
The root directory to be used when resolving relative paths or when accessing bundle:// URIs on platforms that don't offer bundles.
Member
borderOutlineColor
Type
Color
Default
createRGBColor(0., 0., 0., 1.0)
Description
The border outline color, defaults to black.
Member
camera
Type
CameraSettings: CameraClampingSettings clamping
Default
{}
Description
Settings that configure the behavior of the camera.
Member
checkScopesInAPIs
Type
bool
Default
true
Description
Whether APIs calls that perform edits should throw errors if the corresponding scope does not allow the edit.
Member
clearColor
Type
Color
Default
createClear()
Description
The color with which the render target is cleared before scenes get rendered. Only used while renderMode == Preview, else #00000000 (full transparency) is used.
Member
colorMaskingSettings
Type
ColorMaskingSettings(Color maskColor, bool secondPass)
Default
{}
Description
A collection of settings used to perform color masking.
Member
controlGizmo
Type
ControlGizmoSettings(bool showCropHandles, bool showCropScaleHandles, bool showResizeHandles, bool showScaleHandles, bool showRotateHandles)
Default
{}
Description
Settings that configure which touch/click targets for move/scale/rotate/etc. are enabled and displayed.
Member
cropOverlayColor
Type
Color
Default
createRGBColor(0., 0., 0., 0.39)
Description
Color of the dimming overlay that's added in crop mode.
Member
debug
Type
DebugFlags(bool useDebugMipmaps, bool showHandlesInteractionArea)
Default
{}
Description
?
Member
defaultEmojiFontFileUri
Type
string
Default
EMOJI_FONT
Description
URI of default font file for emojis.
Member
defaultFontFileUri
Type
string
Default
DEFAULT_FONT
Description
URI of default font file This font file is the default everywhere unless overriden in specific settings.
Member
doubleClickSelectionMode
Type
DoubleClickSelectionMode
Default
Hierarchical
Description
The current mode of selection on double-click.
Member
doubleClickToCropEnabled
Type
bool
Default
true
Description
Whether double clicking on an image element should switch into the crop editing mode.
Member
emscriptenCORSConfigurations
Type
vector< CORSConfiguration >
Default
{}
Description
CORS Configurations: <origin, value> pairs. See FetchAsyncService-emscripten.cpp for details.
Member
errorStateColor
Type
Color
Default
createRGBColor(1., 1., 1., 0.7)
Description
The error state color for design blocks.
Member
globalScopes
Type
GlobalScopes(Text text, Fill fill, Stroke stroke, Shape shape, Layer layer, Appearance appearance, Lifecycle lifecycle, Editor editor)
Default
Allow)
Description
Global scopes.
Member
handleFillColor
Type
Color
Default
createWhite()
Description
The fill color for handles.
Member
highlightColor
Type
Color
Default
createRGBColor(0.2, 85. / 255., 1.)
Description
Color of the selection, hover, and group frames and for the handle outlines for non-placeholder elements.
Member
license
Type
string
Default
""
Description
A valid license string in JWT format.
Member
maxImageSize
Type
int
Default
4096
Description
The maximum size at which images are loaded into the engine. Images that exceed this size are down-scaled prior to rendering. Reducing this size further reduces the memory footprint. Defaults to 4096x4096.
Member
mouse
Type
MouseSettings(bool enableZoom, bool enableScroll)
Default
{}
Description
Settings that configure the behavior of the mouse.
Member
page
Type
PageSettings(PageTitleSettings title, Color marginFillColor, Color marginFrameColor, Color innerBorderColor, Color outerBorderColor, bool dimOutOfPageAreas)
Default
{}
Description
Page related settings.
Member
placeholderControls
Type
PlaceholderControlsSettings(bool showOverlay, bool showButton)
Default
{}
Description
Supersedes how the blocks' placeholder controls are applied.
Member
placeholderHighlightColor
Type
Color
Default
createRGBColor(0.77, 0.06, 0.95)
Description
Color of the selection, hover, and group frames and for the handle outlines for placeholder elements.
Member
positionSnappingThreshold
Type
float
Default
4.
Description
Position snapping threshold in screen space.
Member
progressColor
Type
Color
Default
createRGBColor(1., 1., 1., 0.7)
Description
The progress indicator color.
Member
renderTextCursorAndSelectionInEngine
Type
bool
Default
true
Description
Whether the engine should render the text cursor and selection highlights during text editing. This can be set to false, if the platform wants to perform this rendering itself.
Member
rotationSnappingGuideColor
Type
Color
Default
createRGBColor(1., 0.004, 0.361)
Description
Color of the rotation snapping guides.
Member
rotationSnappingThreshold
Type
float
Default
0.15
Description
Rotation snapping threshold in radians.
Member
ruleOfThirdsLineColor
Type
Color
Default
createRGBColor(0.75, 0.75, 0.75, 0.75)
Description
Color of the rule-of-thirds lines.
Member
showBuildVersion
Type
bool
Default
false
Description
Show the build version on the canvas.
Member
snappingGuideColor
Type
Color
Default
createRGBColor(1., 0.004, 0.361)
Description
Color of the position snapping guides.
Member
textVariableHighlightColor
Type
Color
Default
createRGBColor(0.7, 0., 0.7)
Description
Color of the text variable highlighting borders.
Member
touch
Type
TouchSettings(bool dragStartCanSelect, bool singlePointPanning, PinchGestureAction pinchAction, RotateGestureAction rotateAction)
Default
{}
Description
Settings that configure which touch gestures are enabled and which actions they trigger.

TouchSettings#

MemberTypeDefaultDescription
Member
dragStartCanSelect
Type
bool
Default
true
Description
Whether dragging an element requires selecting it first. When not set, elements can be directly dragged.
Member
pinchAction
Type
PinchGestureAction
Default
Scale
Description
The action to perform when a pinch gesture is performed.
Member
rotateAction
Type
RotateGestureAction
Default
Rotate
Description
Whether or not the two finger turn gesture can rotate selected elements.
Member
singlePointPanning
Type
bool
Default
true
Description
Whether or not dragging on the canvas should move the camera (scrolling). When not set, the scroll bars have to be used. This setting might get overwritten with the feature flag preventScrolling.