Public Member Functions | Static Public Attributes

ILayerManager Class Reference

This reference page is linked to from the following overview topics: Iterating over Layers by Name.


Search for all occurrences

Detailed Description

This class is an interface to the layer manager.

Note that some methods of this class are not functional in 3ds Max (only in 3D Studio VIZ). To get a pointer to the global instance of this class use the following code:

See also:
Class ReferenceTarget, Class ILayer, Class Interface13

#include <ilayermanager.h>

Inheritance diagram for ILayerManager:
Inheritance graph
[legend]

List of all members.

Public Member Functions

SClass_ID  SuperClassID ()
  Retrieves a constant representing the type of the plugin.
virtual bool  AddLayer (ILayer *layer)=0
virtual ILayer CreateLayer (void)=0
virtual ILayer CreateLayer (MSTR &name)=0
virtual BOOL  DeleteLayer (const MSTR &name)=0
virtual void  SetCurrentLayer (const MSTR &name)=0
virtual void  SetCurrentLayer (void)=0
virtual ILayer GetCurrentLayer (void) const =0
virtual void  EditLayer (const MSTR &name)=0
virtual void  DoLayerPropDialog (HWND hWnd)=0
virtual int  GetLayerCount (void)=0
virtual ILayer GetLayer (int) const =0
  Gets the specified layer by index.
virtual ILayer GetLayer (const MSTR &name) const =0
virtual void  DoLayerSelDialog (HWND hWnd)=0
virtual void  SetupToolList2 (HWND hWnd, HWND hParent)=0
virtual void  ExtendMenu (HMENU hMenu, bool geometry=true, bool grid=false)=0
virtual MSTR  GetSavedLayer (int i) const =0
virtual ILayer GetRootLayer () const =0
virtual void  Reset (BOOL fileReset=FALSE)=0
virtual void  SelectObjectsByLayer (HWND hWnd)=0
virtual void  SetPropagateToLayer (int prop)=0
virtual int  GetPropagateToLayer (void)=0

Static Public Attributes

static const SClass_ID  kLayerManagerSuperClassID
  The super class ID of the layer manager interface.

Member Function Documentation

SClass_ID SuperClassID ( ) [inline, virtual]

Retrieves a constant representing the type of the plugin.

Returns:
A super class id that uniquely identifies the type (category) of the plugin. Note that several plugin classes can be of the same type, thus return the same super class id. Plugins are uniquely identified by their class ids. List of Super Class IDs.
See also:
SClass_ID

Reimplemented from ReferenceTarget.

virtual bool AddLayer ( ILayer layer ) [pure virtual]
Remarks:
Adds the specified layer.
Parameters:
ILayer *layer

Points to the layer to add.
Returns:
Returns true if the layer was added; false if not.
virtual ILayer* CreateLayer ( void  ) [pure virtual]
Remarks:
Creates a layer. The name is based on the incremented layer count.
virtual ILayer* CreateLayer ( MSTR name ) [pure virtual]
virtual BOOL DeleteLayer ( const MSTR name ) [pure virtual]
Remarks:
Deletes the layer whose name is passed.
Parameters:
MSTR name - The name for the layer.
Returns:
TRUE if the layer was deleted, otherwise FALSE.
virtual void SetCurrentLayer ( const MSTR name ) [pure virtual]
Remarks:
Sets the layer whose name is passed as current.
Parameters:
const MSTR &name

The name for the new current layer.
virtual void SetCurrentLayer ( void  ) [pure virtual]
Remarks:
Sets the current layer based on the selection set (the common layer).
virtual ILayer* GetCurrentLayer ( void  ) const [pure virtual]
Remarks:
Returns an interface to the current layer.
virtual void EditLayer ( const MSTR name ) [pure virtual]
Remarks:
Edits the layer whose name is passed. Note: This method does nothing in 3ds Max.
Parameters:
const MSTR &name

The name of the layer to edit.
virtual void DoLayerPropDialog ( HWND  hWnd ) [pure virtual]
Remarks:
Brings up the layer property dialog. Note: This method does nothing in 3ds Max.
Parameters:
HWND hWnd

The parent window handle.
virtual int GetLayerCount ( void  ) [pure virtual]
Remarks:
Returns the number of layers.
virtual ILayer* GetLayer ( int  ) const [pure virtual]

Gets the specified layer by index.

virtual ILayer* GetLayer ( const MSTR name ) const [pure virtual]
Remarks:
Returns a pointer to a layer interface for the named layer.
Parameters:
const MSTR &name

The name of the layer to get.
virtual void DoLayerSelDialog ( HWND  hWnd ) [pure virtual]
Remarks:
Brings up the select layer dialog. Note: This method does nothing in 3ds Max.
Parameters:
HWND hWnd

The parent window handle.
virtual void SetupToolList2 ( HWND  hWnd,
HWND  hParent 
) [pure virtual]
Remarks:
Sets up the toolbar list.
Parameters:
HWND hWnd

The parent window handle.
virtual void ExtendMenu ( HMENU  hMenu,
bool  geometry = true,
bool  grid = false 
) [pure virtual]
Remarks:
Extends the right click menu. Note: This method does nothing in 3ds Max.
Parameters:
HMENU hMenu

The handle of the menu to append to.

bool geometry = true

Use true to add the geometry commands; false to not add them.

bool grid = false

Use true to add the grid commands; false to not add them.
virtual MSTR GetSavedLayer ( int  i ) const [pure virtual]
virtual ILayer* GetRootLayer ( ) const [pure virtual]
Remarks:
Returns an interface to the 0 layer.
virtual void Reset ( BOOL  fileReset = FALSE ) [pure virtual]
Remarks:
Resets the layer manager.
Parameters:
BOOL fileReset = FALSE

This parameter is ignored.
virtual void SelectObjectsByLayer ( HWND  hWnd ) [pure virtual]
Remarks:
This method will bring up the select objects by layer dialog.
Parameters:
HWND hWnd

The handle to the parent window.
virtual void SetPropagateToLayer ( int  prop ) [pure virtual]
virtual int GetPropagateToLayer ( void  ) [pure virtual]

Member Data Documentation

const SClass_ID kLayerManagerSuperClassID [static]

The super class ID of the layer manager interface.


ILayerManager ILayerManager ILayerManager ILayerManager ILayerManager ILayerManager ILayerManager ILayerManager ILayerManager ILayerManager
ILayerManager ILayerManager ILayerManager ILayerManager ILayerManager ILayerManager ILayerManager ILayerManager ILayerManager ILayerManager