API Documentation > Interfaces > Interface LayerState
Interface LayerState

package com.ptc.wfc.wfcLayerState;

public interface LayerState
extends com.ptc.wfc.wfcModelItem.WModelItem


Description
Provides information of the layer state.
Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WParameterOwner :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WRelationOwner :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItem :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WModelItem :
Method Summary
void
Activate specified layer state.
void
AddLayer (Layer Layer, DisplayStatus DispStatus)
Add layer reference to a layer state.
void
Delete specified layer state.
String
Retrieves the name of the default layer of the specified type.
Get method for attribute "LayerData"
Get layer state reference data.
String
Get method for attribute "LayerStateName"
Returns the name of the layer state.
void
Added an item to be hidden on the layer state.
boolean
Check if the item is hidden on the layer state.
void
Remove layer reference from a layer state.
void
SetDefaultLayer (DefLayerType DefLayerType, String DefaultLayerName)
Sets up a default layer of the specified type.
void
Remove the item from the layer state hidden items list.
Method Detail
GetLayerStateName
String
GetLayerStateName
()
Returns the name of the layer state.
User Guide References:
GetLayerData
GetLayerData
()
Get layer state reference data.
User Guide References:
AddLayer
void
AddLayer
(Layer Layer, DisplayStatus DispStatus)
Add layer reference to a layer state.
Exceptions thrown (but not limited to):
XToolkitBadContext - Passed models of either layer state or the layer are not of ProSolid type.
XToolkitNotFound - Layer state is not found.
XToolkitNotExist - Layer does not exist.
User Guide References:
Parameters:
Layer
DispStatus
Returns:
RemoveLayer
void
RemoveLayer
(Layer Layer)
Remove layer reference from a layer state.
Exceptions thrown (but not limited to):
XToolkitBadContext - Passed models of either layer state or the layer are not of ProSolid type.
XToolkitNotFound - Layer state or Layer is not found.
XToolkitNotExist - Layer does not exist.
User Guide References:
Parameters:
Layer
Returns:
DeleteLayerState
void
DeleteLayerState
()
Delete specified layer state.
Exceptions thrown (but not limited to):
XToolkitNotFound - Layer state not found.
User Guide References:
Returns:
ActivateLayerState
void
ActivateLayerState
()
Activate specified layer state.
Model of the layer state must be top model in window. Otherwise activate fails.
Exceptions thrown (but not limited to):
XToolkitNotFound - Layer state not found.
User Guide References:
Returns:
UnhideLayerItem
void
UnhideLayerItem
(ModelItem LayerItem)
Remove the item from the layer state hidden items list.
Exceptions thrown (but not limited to):
XToolkitNotExist - Layer state not found.
XToolkitNoChange - Item is unhidden already.
User Guide References:
Parameters:
LayerItem
Returns:
HideLayerItem
void
HideLayerItem
(ModelItem LayerItem)
Added an item to be hidden on the layer state.
Exceptions thrown (but not limited to):
XToolkitNotExist - Layer state not found.
XToolkitNoChange - Item is already hidden on the layer state.
User Guide References:
Parameters:
LayerItem
Returns:
IsLayerItemHidden
boolean
IsLayerItemHidden
(ModelItem LayerItem)
Check if the item is hidden on the layer state.
Exceptions thrown (but not limited to):
XToolkitNotExist - Layer state not found.
User Guide References:
Parameters:
LayerItem
Returns:
SetDefaultLayer
void
SetDefaultLayer
(DefLayerType DefLayerType, String DefaultLayerName)
Sets up a default layer of the specified type.
This function is equivalent to setting the default layer name for the session using the configuration option "def_layer". This does not save the status to a particular model. The default layer status does not remain on a layer if it is renamed.
Exceptions thrown (but not limited to):
XToolkitInvalidName - def_layer_name contains invalid characters.
User Guide References:
Parameters:
DefLayerType
DefaultLayerName
Returns:
GetDefaultLayer
String
GetDefaultLayer
(DefLayerType DefLayerType)
Retrieves the name of the default layer of the specified type.
User Guide References:
Parameters:
DefLayerType
Returns:
Was this helpful?