FormIt.SectionPlanes API

Description

Functions
json	FormIt.SectionPlanes.Clear ()
	Clear the list of section planes created from calls to FormIt.SectionPlanes.SetPlanes.
json	FormIt.SectionPlanes.SetPlanes (planes)
	Set the current Section Planes.
json	FormIt.SectionPlanes.GetPlanes ()
	Get the current Section Planes.
json	FormIt.SectionPlanes.GetInstances ()
	Get the WSM group instances representing section planes.
json	FormIt.SectionPlanes.GetPlaneLayers ()
	Get the WSM layers that represent section planes.
json	FormIt.SectionPlanes.SetOutlineColor (color)
	Set the section plane outline color.
json	FormIt.SectionPlanes.GetOutlineColor ()
	Get the section plane outline color.
json	FormIt.SectionPlanes.SetOutlineSize (s)
	Set the section plane outline size.
json	FormIt.SectionPlanes.GetOutlineSize ()
	Get the section plane outline size.
json	FormIt.SectionPlanes.SetSectionIndicatorsVisibility (visible)
	Set the geometry representing section planes visible.
json	FormIt.SectionPlanes.SetPocheColor (color)
	Set the section plane Poche color.
json	FormIt.SectionPlanes.GetPocheColor ()
	Get the section plane Poche color.
json	FormIt.SectionPlanes.EnablePocheColor (enable)
	Enable the Poche color given a bool.
json	FormIt.SectionPlanes.IsPocheColorEnabled ()
	IsPocheColorEnabled returns the Poche color state (on/off).
json	FormIt.SectionPlanes.SectionPlaneHistoryChanged ()
	SectionPlaneHistoryChanged returns true if the section plane History has changed.
json	FormIt.SectionPlanes.SetLastSectionRefHistory (historyId)
	Enable the Poche color given a bool.
json	FormIt.SectionPlanes.GetLastSectionRefHistory ()
	Get the History ID that represents a section plane.

Function Documentation

Clear()

json FormIt.SectionPlanes.Clear

(

)

Clear the list of section planes created from calls to FormIt.SectionPlanes.SetPlanes.

This API does not clear the section planes generated from the section plane Object attribute. Out: JSON_UNDEFINED

Returns

JSON_UNDEFINED, i.e. {}

EnablePocheColor()

json FormIt.SectionPlanes.EnablePocheColor

(

enable

)

Enable the Poche color given a bool.

Parameters

[in]

enable

bool

Returns

JSON_UNDEFINED, i.e. {}

GetInstances()

json FormIt.SectionPlanes.GetInstances

(

)

Get the WSM group instances representing section planes.

Returns

Array of WSM.GroupInstancePath

GetLastSectionRefHistory()

json FormIt.SectionPlanes.GetLastSectionRefHistory

(

)

Get the History ID that represents a section plane.

Returns

History ID

GetOutlineColor()

json FormIt.SectionPlanes.GetOutlineColor

(

)

Get the section plane outline color.

Returns

WSM.Color

GetOutlineSize()

json FormIt.SectionPlanes.GetOutlineSize

(

)

Get the section plane outline size.

Returns

Outline size

GetPlaneLayers()

json FormIt.SectionPlanes.GetPlaneLayers

(

)

Get the WSM layers that represent section planes.

Returns

Array of WSM.ObjectHistoryId

GetPlanes()

json FormIt.SectionPlanes.GetPlanes

(

)

Get the current Section Planes.

Returns

Array of WSM.Plane

GetPocheColor()

json FormIt.SectionPlanes.GetPocheColor

(

)

Get the section plane Poche color.

Returns

WSM.Color

IsPocheColorEnabled()

json FormIt.SectionPlanes.IsPocheColorEnabled

(

)

IsPocheColorEnabled returns the Poche color state (on/off).

Returns

bool

SectionPlaneHistoryChanged()

json FormIt.SectionPlanes.SectionPlaneHistoryChanged

(

)

SectionPlaneHistoryChanged returns true if the section plane History has changed.

Returns

bool

SetLastSectionRefHistory()

json FormIt.SectionPlanes.SetLastSectionRefHistory

(

historyId

)

Enable the Poche color given a bool.

Parameters

[in]

historyId

int

Returns

JSON_UNDEFINED, i.e. {}

SetOutlineColor()

json FormIt.SectionPlanes.SetOutlineColor

(

color

)

Set the section plane outline color.

Parameters

[in]

color

WSM.Color

Returns

JSON_UNDEFINED, i.e. {}

SetOutlineSize()

json FormIt.SectionPlanes.SetOutlineSize

(

s

)

Set the section plane outline size.

Parameters

[in]

s

float

Returns

JSON_UNDEFINED, i.e. {}

SetPlanes()

json FormIt.SectionPlanes.SetPlanes

(

planes

)

Set the current Section Planes.

Parameters

[in]

planes

Array of WSM.Plane

Returns

JSON_UNDEFINED, i.e. {}

SetPocheColor()

json FormIt.SectionPlanes.SetPocheColor

(

color

)

Set the section plane Poche color.

Parameters

[in]

color

WSM.Color

Returns

JSON_UNDEFINED, i.e. {}

SetSectionIndicatorsVisibility()

json FormIt.SectionPlanes.SetSectionIndicatorsVisibility

(

visible

)

Set the geometry representing section planes visible.

Parameters

[in]

visible

bool

Returns

JSON_UNDEFINED, i.e. {}