CIP JavaScript documentation for class " pfcLayer"

Class pfcLayer

Description

This class describes a layer.

The possible values for the display status are as follows:

LAYER_NORMAL
LAYER_DISPLAY
LAYER_BLANK
LAYER_HIDDEN

Direct Parent Classes:: pfcModelItem

Property Summary


`pfcDisplayStatus`	`Status`
	The display status

Method Summary


`void`	`AddItem (pfcModelItem Item)`
	Adds the specified item to the layer.

`number`	`CountUnsupportedItems ()`


`void`	`Delete ()`
	Deletes the layer.

`boolean`	`HasUnsupportedItems ()`
	Returns `true` if the layer contains one or more item types not supported as `pfcModelItem` objects in PFC. Returns `false` otherwise.

`pfcModelItems`	`ListItems ()`
	This method returns only items which are supported as `pfcModelItem` objects in PFC. To identify if the layer has any items not supported in PFC, use `pfcLayer.HasUnsupportedItems()`.

`void`	`RemoveItem (pfcModelItem Item)`
	Removes the specified item from the layer.

Property Detail

pfcDisplayStatus Status

The display status

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified layer was not found.

pfcXToolkitInvalidName - You specified an invalid layer name.

pfcXToolkitCantModify - display status of the layer cannot be changed

Method Detail

void AddItem (pfcModelItem Item)

Adds the specified item to the layer.

The following items cannot be added to a layer: ITEM_SURFACE, ITEM_EDGE, ITEM_COORD_SYS, ITEM_AXIS, ITEM_SIMPREP, ITEM_DTL_SYM_DEFINITION, ITEM_DTL_OLE_OBJECT, ITEM_EXPLODED_STATE. For these items the method will throw pfcXToolkitInvalidType exception.

Exceptions thrown(but not limited to):

pfcXToolkitInvalidName - You specified an invalid layer name.

pfcXToolkitInvalidType - You specified an invalid layer item type.

Parameters:

Item: The item to add

number CountUnsupportedItems ()

Returns:

void Delete ()

Deletes the layer.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidName - You specified an invalid layer name.

pfcXToolkitNotFound - The system could not find a layer with the specified name.

boolean HasUnsupportedItems ()

Returns true if the layer contains one or more item types not supported as pfcModelItem objects in PFC. Returns false otherwise.

Returns:

pfcModelItems ListItems ()

This method returns only items which are supported as pfcModelItem objects in PFC. To identify if the layer has any items not supported in PFC, use pfcLayer.HasUnsupportedItems().

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - A layer with the specified name was not found.

pfcXToolkitOutOfMemory - The layer has too many items to report.

Returns:: An array of the items on the layer

void RemoveItem (pfcModelItem Item)

Removes the specified item from the layer.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified layer was not found.

pfcXToolkitInvalidName - You specified an invalid layer name.

pfcXToolkitInvalidType - You specified an invalid layer item type.

Parameters:

Item: The layer item to remove