API Documentation > Interface Classes > Class wfcLayerState
Class wfcLayerState

# include <wfcLayerState.h>

class wfcLayerState
: public virtual wfcWModelItem
{
xaideclare(wfcLayerState)
...
};


Description
Provides information of the layer state.
Methods Inherited from Class pfcActionSource::
Methods Inherited from Class pfcParent::
Methods Inherited from Class pfcParameterOwner::
Methods Inherited from Class wfcWParameterOwner::
Methods Inherited from Class pfcRelationOwner::
Methods Inherited from Class wfcWRelationOwner::
Methods Inherited from Class pfcChild::
Methods Inherited from Class pfcModelItem::
Methods Inherited from Class wfcWModelItem::
Method Summary
void
Activate specified layer state.
void
Add layer reference to a layer state.
void
Delete specified layer state.
Retrieves the name of the default layer of the specified type.
Get layer state reference data.
Returns the name of the layer state.
void
Added an item to be hidden on the layer state.
Check if the item is hidden on the layer state.
void
Remove layer reference from a layer state.
void
SetDefaultLayer (wfcDefLayerType DefLayerType, xrstring DefaultLayerName)
Sets up a default layer of the specified type.
void
Remove the item from the layer state hidden items list.
Method Detail
GetLayerStateName
()
Returns the name of the layer state.
User Guide References:
GetLayerData
()
Get layer state reference data.
User Guide References:
void
AddLayer
(pfcLayer_ptr Layer, pfcDisplayStatus DispStatus)
Add layer reference to a layer state.
Exceptions thrown (but not limited to):
pfcXToolkitBadContext - Passed models of either layer state or the layer are not of ProSolid type.
pfcXToolkitNotFound - Layer state is not found.
pfcXToolkitNotExist - Layer does not exist.
User Guide References:
Parameters:
Layer
DispStatus
Returns:
void
RemoveLayer
(pfcLayer_ptr Layer)
Remove layer reference from a layer state.
Exceptions thrown (but not limited to):
pfcXToolkitBadContext - Passed models of either layer state or the layer are not of ProSolid type.
pfcXToolkitNotFound - Layer state or Layer is not found.
pfcXToolkitNotExist - Layer does not exist.
User Guide References:
Parameters:
Layer
Returns:
void
DeleteLayerState
()
Delete specified layer state.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - Layer state not found.
User Guide References:
Returns:
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):
pfcXToolkitNotFound - Layer state not found.
User Guide References:
Returns:
void
UnhideLayerItem
(pfcModelItem_ptr LayerItem)
Remove the item from the layer state hidden items list.
Exceptions thrown (but not limited to):
pfcXToolkitNotExist - Layer state not found.
pfcXToolkitNoChange - Item is unhidden already.
Parameters:
LayerItem
Returns:
void
HideLayerItem
(pfcModelItem_ptr LayerItem)
Added an item to be hidden on the layer state.
Exceptions thrown (but not limited to):
pfcXToolkitNotExist - Layer state not found.
pfcXToolkitNoChange - Item is already hidden on the layer state.
User Guide References:
Parameters:
LayerItem
Returns:
IsLayerItemHidden
(pfcModelItem_ptr LayerItem)
Check if the item is hidden on the layer state.
Exceptions thrown (but not limited to):
pfcXToolkitNotExist - Layer state not found.
User Guide References:
Parameters:
LayerItem
Returns:
void
SetDefaultLayer
(wfcDefLayerType DefLayerType, xrstring 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):
pfcXToolkitInvalidName - def_layer_name contains invalid characters.
User Guide References:
Parameters:
DefLayerType
DefaultLayerName
Returns:
GetDefaultLayer
(wfcDefLayerType DefLayerType)
Retrieves the name of the default layer of the specified type.
User Guide References:
Parameters:
DefLayerType
Returns:
Was this helpful?