Description

Functions
json	FormIt.VisualStyles.GetShadowsVisible ()
	< EffectCache.EffectType

json	FormIt.VisualStyles.SetShadowsVisible (val)
	GetRenderShadowVisibility adjusts the setting to show shadows Parameters: In: val (bool) Out: JSON_UNDEFINED

json	FormIt.VisualStyles.GetAlwaysDrawInstanceBoxes ()
	GetAlwaysDrawInstanceBoxes determines whether bounding boxes are visible Parameters: In: None Out: { bool } representing the state of bounding box visibility

json	FormIt.VisualStyles.SetAlwaysDrawInstanceBoxes (val)
	SetGroupBoundingBoxVisibility adjusts whether bounding boxes are visible Parameters: In: val (bool) Out: JSON_UNDEFINED

json	FormIt.VisualStyles.IsGroundPlaneVisible ()
	IsGroundPlaneVisible indicates whether or not the ground plane will be drawn Parameters: In: None Out: { bool }

json	FormIt.VisualStyles.SetGroundPlaneVisible (val)
	SetGroundPlaneVisible sets whether or not the ground plane will be drawn Parameters: In: val (bool) true == ground plane will be drawn Out: JSON_UNDEFINED

json	FormIt.VisualStyles.IsWorkPlaneVisible ()
	IsWorkPlaneVisible indicates whether or not the work plane will be drawn Parameters: In: None Out: { bool }

json	FormIt.VisualStyles.SetWorkPlaneVisible (val)
	SetWorkPlaneVisible sets whether or not the work plane will be drawn Parameters: In: val (bool) true == work plane will be drawn Out: JSON_UNDEFINED

json	FormIt.VisualStyles.GetNorthArrowDisplay ()
	Returns true if the North arrow is set

json	FormIt.VisualStyles.SetNorthArrowDisplay (bOn)
	Sets if the North arrow should display - true to display, false to not display

json	FormIt.VisualStyles.ToggleNorthArrowDisplay ()
	toggles the North arrow display

json	FormIt.VisualStyles.IsNorthArrowVisible ()
	returns true if the North arrow is set to display, false otherwise

json	FormIt.VisualStyles.GetShowAxes ()
	Returns true if the axes are being shown, false otherwise

json	FormIt.VisualStyles.SetShowAxes (bShow)
	Sets if the axes should be drawn.

json	FormIt.VisualStyles.SetShowSilhouettes (bShow)
	Sets if silhouettes should be drawn.

json	FormIt.VisualStyles.SetShowEdges (bShow)
	Sets if edges should be drawn.

json	FormIt.VisualStyles.IsGridVisible ()
	Return the grid display status Parameters: In: Out: bVisible

json	FormIt.VisualStyles.SetGridVisible (bVisible)
	Set the grid display status Parameters: In: bVisible Out: JSON_UNDEFINED

json	FormIt.VisualStyles.GetHighlightPreselect ()
	Return the preselect highlight display status Parameters: In: Out: bHighlight

json	FormIt.VisualStyles.SetHighlightPreselect (bHighlight)
	Set the preselect highlight display status Parameters: In: bHighlight Out: JSON_UNDEFINED

json	FormIt.VisualStyles.SetAmbientColorIntensity (i)
	Sets the "ambient color intensity," or how "bright" unlit, colored faces will appear.

json	FormIt.VisualStyles.GetAmbientColorIntensity ()
	Get ambient color intensity

json	FormIt.VisualStyles.SetAmbientTextureIntensity (i)
	Sets the "ambient texture color intensity," or how "bright" unlit, textured faces will appear.

json	FormIt.VisualStyles.GetAmbientTextureIntensity ()
	Get ambient texture intensity

json	FormIt.VisualStyles.SetAmbientMaterialIntensity (i)
	SetAmbientMaterialIntensity() function.

json	FormIt.VisualStyles.SetSunShading (i)
	SetSunShading() function.

json	FormIt.VisualStyles.GetSunShading ()
	GetSunShading() function.

json	FormIt.VisualStyles.SetShadowIntensity (i)
	Sets the "shadow intensity," or how "dark" shadows appear.

json	FormIt.VisualStyles.GetShadowIntensity ()
	Get the shadow intensity

json	FormIt.VisualStyles.SetAdvancedMaterialShaderType (type)
	Sets the shader type to use for materials

json	FormIt.VisualStyles.GetAdvancedMaterialShaderType ()
	Get the current material shader type

json	FormIt.VisualStyles.IsSkyRendered ()
	IsSkyRendered() function.

json	FormIt.VisualStyles.SetSkyRendered (b)
	SetSkyRendered() function.

json	FormIt.VisualStyles.IsFogRendered ()
	IsFogRendered() function.

json	FormIt.VisualStyles.SetFogRendered (b)
	SetFogRendered() function.

json	FormIt.VisualStyles.SetSkyLowerColor (color)
	SetSkyLowerColor() function.

json	FormIt.VisualStyles.GetSkyLowerColor ()
	GetSkyLowerColor() function.

json	FormIt.VisualStyles.SetSkyUpperColor (color)
	SetSkyUpperColor() function.

json	FormIt.VisualStyles.GetSkyUpperColor ()
	GetSkyUpperColor() function.

json	FormIt.VisualStyles.SetBackgroundColor (color)
	SetBackgroundColor() function.

json	FormIt.VisualStyles.GetBackgroundColor ()
	GetBackgroundColor() function.

json	FormIt.VisualStyles.SetGroundPlaneColor (color)
	SetGroundPlaneColor() function.

json	FormIt.VisualStyles.GetGroundPlaneColor ()
	GetGroundPlaneColor() function.

json	FormIt.VisualStyles.SetGroundPlaneTransparency (transparency)
	SetGroundPlaneTransparency() function.

json	FormIt.VisualStyles.GetGroundPlaneTransparency ()
	GetGroundPlaneTransparency() function.

json	FormIt.VisualStyles.SetWorkPlaneColor (color)
	SetWorkPlaneColor() function.

json	FormIt.VisualStyles.GetWorkPlaneColor ()
	GetWorkPlaneColor() function.

json	FormIt.VisualStyles.SetSunEditorEnabled (bEnabled)
	SetSunEditorEnabled() function.

json	FormIt.VisualStyles.GetSunEditorEnabled ()
	GetSunEditorEnabled() function.

json	FormIt.VisualStyles.GetEdgeWeight ()
	GetEdgeWeight() function.

json	FormIt.VisualStyles.SetEdgeWeight (weight)
	SetEdgeWeight() function.

json	FormIt.VisualStyles.GetEdgeColor ()
	GetEdgeColor() function.

json	FormIt.VisualStyles.SetEdgeColor (color)
	SetEdgeColor() function.

json	FormIt.VisualStyles.GetSilhouetteWeight ()
	GetSilhouetteWeight() function.

json	FormIt.VisualStyles.SetSilhouetteWeight (weight)
	SetSilhouetteWeight() function.

json	FormIt.VisualStyles.IsRenderSettingActive (flag)
	IsRenderSettingActive returns bool if the particular render mode is set Parameters: In: solid render flag enum Out: bool

json	FormIt.VisualStyles.SetRenderSettingFlags (flag, b)
	SetRenderSettingFlags takes a SolidRendererFlags and bool to enable the flag Parameters: In: flag, b solid render flag enum (FormIt.SolidRendererFlags), bool (on/off) Out: JSON_UNDEFINED

Function Documentation

◆ GetAdvancedMaterialShaderType()

json FormIt.VisualStyles.GetAdvancedMaterialShaderType ( )

Get the current material shader type

Returns: FY.EffectCache.EffectType

◆ GetAlwaysDrawInstanceBoxes()

json FormIt.VisualStyles.GetAlwaysDrawInstanceBoxes ( )

GetAlwaysDrawInstanceBoxes determines whether bounding boxes are visible Parameters: In: None Out: { bool } representing the state of bounding box visibility

Returns: {...}

◆ GetAmbientColorIntensity()

json FormIt.VisualStyles.GetAmbientColorIntensity ( )

Get ambient color intensity

Returns: float

◆ GetAmbientTextureIntensity()

json FormIt.VisualStyles.GetAmbientTextureIntensity ( )

Get ambient texture intensity

Returns: float

◆ GetBackgroundColor()

json FormIt.VisualStyles.GetBackgroundColor ( )

GetBackgroundColor() function.

Returns: {...}

◆ GetEdgeColor()

json FormIt.VisualStyles.GetEdgeColor ( )

GetEdgeColor() function.

Returns: {...}

◆ GetEdgeWeight()

json FormIt.VisualStyles.GetEdgeWeight ( )

GetEdgeWeight() function.

Returns: {...}

◆ GetGroundPlaneColor()

json FormIt.VisualStyles.GetGroundPlaneColor ( )

GetGroundPlaneColor() function.

Returns: {...}

◆ GetGroundPlaneTransparency()

json FormIt.VisualStyles.GetGroundPlaneTransparency ( )

GetGroundPlaneTransparency() function.

Returns: {...}

◆ GetHighlightPreselect()

json FormIt.VisualStyles.GetHighlightPreselect ( )

Return the preselect highlight display status Parameters: In: Out: bHighlight

Returns: bHighlight

◆ GetNorthArrowDisplay()

json FormIt.VisualStyles.GetNorthArrowDisplay ( )

Returns true if the North arrow is set

Returns: bool Success

◆ GetShadowIntensity()

json FormIt.VisualStyles.GetShadowIntensity ( )

Get the shadow intensity

Returns: float

◆ GetShadowsVisible()

json FormIt.VisualStyles.GetShadowsVisible ( )

< EffectCache.EffectType

GetRenderShadowVisibility determines whether shadows are visible

Parameters: In: None Out: { bool } representing the state of shadow visibility

Returns: {...}

◆ GetShowAxes()

json FormIt.VisualStyles.GetShowAxes ( )

Returns true if the axes are being shown, false otherwise

Returns: bool Success

◆ GetSilhouetteWeight()

json FormIt.VisualStyles.GetSilhouetteWeight ( )

GetSilhouetteWeight() function.

Returns: {...}

◆ GetSkyLowerColor()

json FormIt.VisualStyles.GetSkyLowerColor ( )

GetSkyLowerColor() function.

Returns: {...}

◆ GetSkyUpperColor()

json FormIt.VisualStyles.GetSkyUpperColor ( )

GetSkyUpperColor() function.

Returns: {...}

◆ GetSunEditorEnabled()

json FormIt.VisualStyles.GetSunEditorEnabled ( )

GetSunEditorEnabled() function.

Returns: {...}

◆ GetSunShading()

json FormIt.VisualStyles.GetSunShading ( )

GetSunShading() function.

Returns: {...}

◆ GetWorkPlaneColor()

json FormIt.VisualStyles.GetWorkPlaneColor ( )

GetWorkPlaneColor() function.

Returns: {...}

◆ IsFogRendered()

json FormIt.VisualStyles.IsFogRendered ( )

IsFogRendered() function.

Returns: {...}

◆ IsGridVisible()

json FormIt.VisualStyles.IsGridVisible ( )

Return the grid display status Parameters: In: Out: bVisible

Returns: bVisible

◆ IsGroundPlaneVisible()

json FormIt.VisualStyles.IsGroundPlaneVisible ( )

IsGroundPlaneVisible indicates whether or not the ground plane will be drawn Parameters: In: None Out: { bool }

Returns: {...}

◆ IsNorthArrowVisible()

json FormIt.VisualStyles.IsNorthArrowVisible ( )

returns true if the North arrow is set to display, false otherwise

Returns: bool Success

◆ IsRenderSettingActive()

json FormIt.VisualStyles.IsRenderSettingActive ( flag )

IsRenderSettingActive returns bool if the particular render mode is set Parameters: In: solid render flag enum Out: bool

Parameters

[in] flag FormIt.SolidRendererFlags

Returns: {...}

◆ IsSkyRendered()

json FormIt.VisualStyles.IsSkyRendered ( )

IsSkyRendered() function.

Returns: {...}

◆ IsWorkPlaneVisible()

json FormIt.VisualStyles.IsWorkPlaneVisible ( )

IsWorkPlaneVisible indicates whether or not the work plane will be drawn Parameters: In: None Out: { bool }

Returns: {...}

◆ SetAdvancedMaterialShaderType()

json FormIt.VisualStyles.SetAdvancedMaterialShaderType ( type )

Sets the shader type to use for materials

Parameters

	FY.EffectCache.EffectType.	Possible values are FormIt.VisualStyles.MaterialShaderType.{Standard,Custom}
[in]	type	int

Returns: JSON_UNDEFINED, i.e. {}

◆ SetAlwaysDrawInstanceBoxes()

json FormIt.VisualStyles.SetAlwaysDrawInstanceBoxes ( val )

SetGroupBoundingBoxVisibility adjusts whether bounding boxes are visible Parameters: In: val (bool) Out: JSON_UNDEFINED

Parameters

[in] val bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetAmbientColorIntensity()

json FormIt.VisualStyles.SetAmbientColorIntensity ( i )

Sets the "ambient color intensity," or how "bright" unlit, colored faces will appear.

Parameters

	float	intensity in the range [0,1]
[in]	i	float

Returns: JSON_UNDEFINED, i.e. {}

◆ SetAmbientMaterialIntensity()

json FormIt.VisualStyles.SetAmbientMaterialIntensity ( i )

SetAmbientMaterialIntensity() function.

Parameters

[in] i float

Returns: JSON_UNDEFINED, i.e. {}

◆ SetAmbientTextureIntensity()

json FormIt.VisualStyles.SetAmbientTextureIntensity ( i )

Sets the "ambient texture color intensity," or how "bright" unlit, textured faces will appear.

Parameters

	float	intensity in the range [0,1]
[in]	i	float

Returns: JSON_UNDEFINED, i.e. {}

◆ SetBackgroundColor()

json FormIt.VisualStyles.SetBackgroundColor ( color )

SetBackgroundColor() function.

Parameters

[in] color WSM.Color

Returns: JSON_UNDEFINED, i.e. {}

◆ SetEdgeColor()

json FormIt.VisualStyles.SetEdgeColor ( color )

SetEdgeColor() function.

Parameters

[in] color WSM.Color

Returns: JSON_UNDEFINED, i.e. {}

◆ SetEdgeWeight()

json FormIt.VisualStyles.SetEdgeWeight ( weight )

SetEdgeWeight() function.

Parameters

[in] weight float

Returns: JSON_UNDEFINED, i.e. {}

◆ SetFogRendered()

json FormIt.VisualStyles.SetFogRendered ( b )

SetFogRendered() function.

Parameters

[in] b bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetGridVisible()

json FormIt.VisualStyles.SetGridVisible ( bVisible )

Set the grid display status Parameters: In: bVisible Out: JSON_UNDEFINED

Parameters

[in] bVisible bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetGroundPlaneColor()

json FormIt.VisualStyles.SetGroundPlaneColor ( color )

SetGroundPlaneColor() function.

Parameters

[in] color WSM.Color

Returns: JSON_UNDEFINED, i.e. {}

◆ SetGroundPlaneTransparency()

json FormIt.VisualStyles.SetGroundPlaneTransparency ( transparency )

SetGroundPlaneTransparency() function.

Parameters

[in] transparency float

Returns: JSON_UNDEFINED, i.e. {}

◆ SetGroundPlaneVisible()

json FormIt.VisualStyles.SetGroundPlaneVisible ( val )

SetGroundPlaneVisible sets whether or not the ground plane will be drawn Parameters: In: val (bool) true == ground plane will be drawn Out: JSON_UNDEFINED

Parameters

[in] val bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetHighlightPreselect()

json FormIt.VisualStyles.SetHighlightPreselect ( bHighlight )

Set the preselect highlight display status Parameters: In: bHighlight Out: JSON_UNDEFINED

Parameters

[in] bHighlight bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetNorthArrowDisplay()

json FormIt.VisualStyles.SetNorthArrowDisplay ( bOn )

Sets if the North arrow should display - true to display, false to not display

Parameters

[in] bOn bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetRenderSettingFlags()

json FormIt.VisualStyles.SetRenderSettingFlags	(	flag	,
		b
	)

SetRenderSettingFlags takes a SolidRendererFlags and bool to enable the flag Parameters: In: flag, b solid render flag enum (FormIt.SolidRendererFlags), bool (on/off) Out: JSON_UNDEFINED

Parameters

[in]	flag	FormIt.SolidRendererFlags
[in]	b	bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetShadowIntensity()

json FormIt.VisualStyles.SetShadowIntensity ( i )

Sets the "shadow intensity," or how "dark" shadows appear.

Parameters

	float	intensity in the range [0,1]
[in]	i	float

Returns: JSON_UNDEFINED, i.e. {}

◆ SetShadowsVisible()

json FormIt.VisualStyles.SetShadowsVisible ( val )

GetRenderShadowVisibility adjusts the setting to show shadows Parameters: In: val (bool) Out: JSON_UNDEFINED

Parameters

[in] val bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetShowAxes()

json FormIt.VisualStyles.SetShowAxes ( bShow )

Sets if the axes should be drawn.

Pass in true to draw, false to not draw

Parameters

[in] bShow bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetShowEdges()

json FormIt.VisualStyles.SetShowEdges ( bShow )

Sets if edges should be drawn.

Pass in true to draw, false to not draw

Parameters

[in] bShow bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetShowSilhouettes()

json FormIt.VisualStyles.SetShowSilhouettes ( bShow )

Sets if silhouettes should be drawn.

Pass in true to draw, false to not draw

Parameters

[in] bShow bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetSilhouetteWeight()

json FormIt.VisualStyles.SetSilhouetteWeight ( weight )

SetSilhouetteWeight() function.

Parameters

[in] weight float

Returns: JSON_UNDEFINED, i.e. {}

◆ SetSkyLowerColor()

json FormIt.VisualStyles.SetSkyLowerColor ( color )

SetSkyLowerColor() function.

Parameters

[in] color WSM.Color

Returns: JSON_UNDEFINED, i.e. {}

◆ SetSkyRendered()

json FormIt.VisualStyles.SetSkyRendered ( b )

SetSkyRendered() function.

Parameters

[in] b bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetSkyUpperColor()

json FormIt.VisualStyles.SetSkyUpperColor ( color )

SetSkyUpperColor() function.

Parameters

[in] color WSM.Color

Returns: JSON_UNDEFINED, i.e. {}

◆ SetSunEditorEnabled()

json FormIt.VisualStyles.SetSunEditorEnabled ( bEnabled )

SetSunEditorEnabled() function.

Parameters

[in] bEnabled bool

Returns: JSON_UNDEFINED

◆ SetSunShading()

json FormIt.VisualStyles.SetSunShading ( i )

SetSunShading() function.

Parameters

[in] i float

Returns: JSON_UNDEFINED, i.e. {}

◆ SetWorkPlaneColor()

json FormIt.VisualStyles.SetWorkPlaneColor ( color )

SetWorkPlaneColor() function.

Parameters

[in] color WSM.Color

Returns: JSON_UNDEFINED, i.e. {}

◆ SetWorkPlaneVisible()

json FormIt.VisualStyles.SetWorkPlaneVisible ( val )

SetWorkPlaneVisible sets whether or not the work plane will be drawn Parameters: In: val (bool) true == work plane will be drawn Out: JSON_UNDEFINED

Parameters

[in] val bool

Returns: JSON_UNDEFINED, i.e. {}

◆ ToggleNorthArrowDisplay()

json FormIt.VisualStyles.ToggleNorthArrowDisplay ( )

toggles the North arrow display

Returns: JSON_UNDEFINED, i.e. {}

Description

Functions

Function Documentation

◆ GetAdvancedMaterialShaderType()

◆ GetAlwaysDrawInstanceBoxes()

◆ GetAmbientColorIntensity()

◆ GetAmbientTextureIntensity()

◆ GetBackgroundColor()

◆ GetEdgeColor()

◆ GetEdgeWeight()

◆ GetGroundPlaneColor()

◆ GetGroundPlaneTransparency()

◆ GetHighlightPreselect()

◆ GetNorthArrowDisplay()

◆ GetShadowIntensity()

◆ GetShadowsVisible()

◆ GetShowAxes()

◆ GetSilhouetteWeight()

◆ GetSkyLowerColor()

◆ GetSkyUpperColor()

◆ GetSunEditorEnabled()

◆ GetSunShading()

◆ GetWorkPlaneColor()

◆ IsFogRendered()

◆ IsGridVisible()

◆ IsGroundPlaneVisible()

◆ IsNorthArrowVisible()

◆ IsRenderSettingActive()

◆ IsSkyRendered()

◆ IsWorkPlaneVisible()

◆ SetAdvancedMaterialShaderType()

◆ SetAlwaysDrawInstanceBoxes()

◆ SetAmbientColorIntensity()

◆ SetAmbientMaterialIntensity()

◆ SetAmbientTextureIntensity()

◆ SetBackgroundColor()

◆ SetEdgeColor()

◆ SetEdgeWeight()

◆ SetFogRendered()

◆ SetGridVisible()

◆ SetGroundPlaneColor()

◆ SetGroundPlaneTransparency()

◆ SetGroundPlaneVisible()

◆ SetHighlightPreselect()

◆ SetNorthArrowDisplay()

◆ SetRenderSettingFlags()

◆ SetShadowIntensity()

◆ SetShadowsVisible()

◆ SetShowAxes()

◆ SetShowEdges()

◆ SetShowSilhouettes()

◆ SetSilhouetteWeight()

◆ SetSkyLowerColor()

◆ SetSkyRendered()

◆ SetSkyUpperColor()

◆ SetSunEditorEnabled()

◆ SetSunShading()

◆ SetWorkPlaneColor()

◆ SetWorkPlaneVisible()

◆ ToggleNorthArrowDisplay()