nxopen.layer

Interface LayerManager

All Superinterfaces:

Remote

public interface LayerManager
extends Remote

Represents an object that manages layers
To obtain an instance of this class, refer to BasePart

Created in NX3.0.0

Method Summary

Modifier and Type	Method and Description
void	applyMoveToLayerToOwningParts(int newLayer, DisplayableObject[] objectArray) Move the selected objects to the specified layer in their Owning Parts.
void	changeStates(StateInfo[] stateArray) Changes the states of the specified layers in the part.
void	changeStates(StateInfo[] stateArray, boolean fitAll) Changes the states of the specified layers in the part.
void	copyObjects(int newLayer, NXObject[] objectArray) Copies objects to the specified layer Objects of class Component , DatumAxis , DatumPlane Edge , Face , Feature or View , may not be copied.
NXObject[]	getAllObjectsOnLayer(int layer) Returns all objects on the specified layer.
State	getState(int layer) Gets the state of the specified layer.
StateCollection	getStates() Gets the states for all layers in the part.
StateInfo[]	getVisibilitiesInView(View view) Gets the visibility of all layers in a specified view.
void	moveDisplayableObjects(int newLayer, DisplayableObject[] objectArray) Moves displayable objects to the specified layer.
void	resetViewVisibilityToGlobal(View view) Resets a view's layer visibility to the global states.
void	setObjectsVisibilityOnLayer(View view, StateInfo[] stateArray, boolean doUpdate) Sets specified layer(s) visibility in a specified view.
void	setState(int layer, State state) Sets the state of the specified layer.
void	setState(int layer, State state, boolean fitAll) Sets the state of the specified layer.
void	setStates(StateCollection stateCollection) Sets the states for all layers in the part.
void	setStates(StateCollection stateCollection, boolean fitAll) Sets the states for all layers in the part.
void	setWorkLayer(int newWorkLayer) Sets the work layer.
int	workLayer() Returns the work layer.

Method Detail

setWorkLayer

void setWorkLayer(int newWorkLayer)
           throws NXException,
                  RemoteException

Sets the work layer. If you change the work layer, the old work layer is changed to Selectable. The part must be the displayed part.
License requirements: None.

Created in NX3.0.0

Parameters:

newWorkLayer - Layer number for the new work layer

Throws:

NXException

RemoteException

workLayer

int workLayer()
       throws NXException,
              RemoteException

Returns the work layer. If you change the work layer, the old work layer is changed to Selectable. The part must be the displayed part.
License requirements: None.

Created in NX3.0.0

Returns:

Layer number of the work layer

Throws:

NXException

RemoteException

changeStates

void changeStates(StateInfo[] stateArray,
                  boolean fitAll)
           throws NXException,
                  RemoteException

Changes the states of the specified layers in the part. Note: there must be exactly one work layer. If you change the work layer, you must specify a new work layer. If you set the work layer, the old work layer will be changed to Selectable, unless you specify otherwise. The part must be the displayed part.
License requirements: None.

Created in NX3.0.0

Parameters:

stateArray - Indicates the new states for the layers.

fitAll - Whether to refit the view to what is visible after the layer states have been changed

Throws:

NXException

RemoteException

changeStates

void changeStates(StateInfo[] stateArray)
           throws NXException,
                  RemoteException

Changes the states of the specified layers in the part. Note: there must be exactly one work layer. If you change the work layer, you must specify a new work layer. If you set the work layer, the old work layer will be changed to Selectable, unless you specify otherwise. The part must be the displayed part.
License requirements: None.

Created in NX3.0.0

Parameters:

stateArray - Indicates the new states for the layers.

Throws:

NXException

RemoteException

getStates

StateCollection getStates()
                   throws NXException,
                          RemoteException

Gets the states for all layers in the part. The part must be the displayed part.
License requirements: None.

Created in NX3.0.0

Returns:

Indicates the states for all layers in the part.

Throws:

NXException

RemoteException

setStates

void setStates(StateCollection stateCollection,
               boolean fitAll)
        throws NXException,
               RemoteException

Sets the states for all layers in the part. The part must be the displayed part. Note: there must be exactly one work layer.
License requirements: None.

Created in NX3.0.0

Parameters:

stateCollection - The states for all layers in the part.

fitAll - Whether to refit the view to what is visible after the layer states have been changed

Throws:

NXException

RemoteException

setStates

void setStates(StateCollection stateCollection)
        throws NXException,
               RemoteException

Sets the states for all layers in the part. The part must be the displayed part. Note: there must be exactly one work layer.
License requirements: None.

Created in NX3.0.0

Parameters:

stateCollection - The states for all layers in the part.

Throws:

NXException

RemoteException

setState

void setState(int layer,
              State state)
       throws NXException,
              RemoteException

Sets the state of the specified layer. The specified layer must not be the work layer. If you are changing the state of the layer to Work, the old work layer will be changed to Selectable. The part must be the displayed part.
License requirements: None.

Created in NX3.0.0

Parameters:

layer -

state -

Throws:

NXException

RemoteException

setState

void setState(int layer,
              State state,
              boolean fitAll)
       throws NXException,
              RemoteException

Sets the state of the specified layer. The specified layer must not be the work layer. If you are changing the state of the layer to Work, the old work layer will be changed to Selectable. The part must be the displayed part.
License requirements: None.

Created in NX3.0.0

Parameters:

layer -

state -

fitAll - Whether to refit the view to what is visible after the layer state has been changed

Throws:

NXException

RemoteException

getState

State getState(int layer)
        throws NXException,
               RemoteException

Gets the state of the specified layer. The part must be the displayed part.
License requirements: None.

Created in NX3.0.0

Parameters:

layer -

Throws:

NXException

RemoteException

moveDisplayableObjects

void moveDisplayableObjects(int newLayer,
                            DisplayableObject[] objectArray)
                     throws NXException,
                            RemoteException

Moves displayable objects to the specified layer. The specified part may be the displayed part or the work part. If it is the work part but not the displayed part, then none of the objects to be moved may be currently displayed.
This method is the preferred way to change the layer of one or more objects, because DisplayableObject.setLayer(int) does not correct the display of the objects and does not work as expected for sketches and components, because it does not move the members of the sketch or component.

Objects of class CAEEdge , CAEFace , CAEVertex , Edge , Face or View may not be moved.

License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Created in NX5.0.0

Parameters:

newLayer - The layer to move the objects to

objectArray - The objects to be moved

Throws:

NXException

RemoteException

applyMoveToLayerToOwningParts

void applyMoveToLayerToOwningParts(int newLayer,
                                   DisplayableObject[] objectArray)
                            throws NXException,
                                   RemoteException

Move the selected objects to the specified layer in their Owning Parts. This only works when a single layer has been selected on the Layer Settings dialog.
The owning parts will be fully loaded if they are not already.

Objects of class CAEEdge , CAEFace , CAEVertex , Edge , Face or View may not be moved.

License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Created in NX7.5.0

Parameters:

newLayer - The layer in the owning parts to move the objects to

objectArray - The objects to be moved

Throws:

NXException

RemoteException

getAllObjectsOnLayer

NXObject[] getAllObjectsOnLayer(int layer)
                         throws NXException,
                                RemoteException

Returns all objects on the specified layer. This includes objects which are not counted as objects on the layer by the "Layer Settings" dialog.
The part must be the displayed part.

License requirements: None.

Created in NX3.0.0

Parameters:

layer -

Returns:

All the objects on the specified layer

Throws:

NXException

RemoteException

copyObjects

void copyObjects(int newLayer,
                 NXObject[] objectArray)
          throws NXException,
                 RemoteException

Copies objects to the specified layer
Objects of class Component , DatumAxis , DatumPlane Edge , Face , Feature or View , may not be copied.

Objects of type UF_cs2_vertex_type may not be copied.

The part must be the work part.

License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Created in NX4.0.0

Parameters:

newLayer - The layer to move the objects to

objectArray - The objects to be copied

Throws:

NXException

RemoteException

getVisibilitiesInView

StateInfo[] getVisibilitiesInView(View view)
                           throws NXException,
                                  RemoteException

Gets the visibility of all layers in a specified view. The part must be the displayed part.
License requirements: None.

Created in NX4.0.3

Parameters:

view - The view object being queried

Throws:

NXException

RemoteException

setObjectsVisibilityOnLayer

void setObjectsVisibilityOnLayer(View view,
                                 StateInfo[] stateArray,
                                 boolean doUpdate)
                          throws NXException,
                                 RemoteException

Sets specified layer(s) visibility in a specified view. The part must be the displayed part.
License requirements: None.

Created in NX4.0.0

Parameters:

view - The view object being modified

stateArray - The new states for the layers. The given states may only be State.VISIBLE and State.HIDDEN .

doUpdate - Whether to update the view(s) after the layer states have been changed

Throws:

NXException

RemoteException

resetViewVisibilityToGlobal

void resetViewVisibilityToGlobal(View view)
                          throws NXException,
                                 RemoteException

Resets a view's layer visibility to the global states. The part must be the displayed part.
License requirements: None.

Created in NX4.0.0

Parameters:

view - The view object

Throws:

NXException

RemoteException