# Layer Class Reference

Related Scripting Object: Layer

The Layer is a self-contained collection of Scene objects. Currently, it implements no functions of its own. More...

`#include <xsi_layer.h>`

Inheritance diagram for Layer:

List of all members.

## Public Member Functions
| Layer ()
| ~Layer ()
| Layer (const CRef &in_ref)
| Layer (const Layer &in_obj)
bool | IsA (siClassID in_ClassID) const
siClassID | GetClassID () const
Layer & | operator= (const Layer &in_obj)
Layer & | operator= (const CRef &in_ref)

## Detailed Description

The Layer is a self-contained collection of Scene objects. Currently, it implements no functions of its own.

You can create a new layer with the CreateLayer command, and access a scene's layers via the Scene: see Scene::GetLayers or Scene::GetActiveLayer.

See also:
  Scene::GetLayers, Scene::GetActiveLayer, CreateLayer

## Constructor & Destructor Documentation

Layer | ( |  | ) |

Default constructor.

~Layer | ( |  | ) |

Default destructor.

Layer | ( | const CRef & | in_ref | ) |

Constructor.

Parameters:

  | in_ref | constant reference object.

Layer | ( | const Layer & | in_obj | ) |

Copy constructor.

Parameters:

  | in_obj | constant class object.

## Member Function Documentation

bool IsA | ( | siClassID | in_ClassID | ) | const`[virtual]`

Returns true if a given class type is compatible with this API class.

Parameters:

  | in_ClassID | class type.

Returns:
  true if the class is compatible, false otherwise.

Reimplemented from Group.

siClassID GetClassID | ( |  | ) | const`[virtual]`

Returns the type of the API class.

Returns:
  The class type.

Reimplemented from Group.

Layer& operator= | ( | const Layer & | in_obj | ) |

Creates an object from another object. The newly created object is set to empty if the input object is not compatible.

Parameters:

  | in_obj | constant class object.

Returns:
  The new Layer object.

Layer& operator= | ( | const CRef & | in_ref | ) |

Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.

Parameters:

  | in_ref | constant class object.

Returns:
  The new Layer object.

Reimplemented from Group.

The documentation for this class was generated from the following file:

- xsi_layer.h