DuAEF.Dugr

Duduf groups
Author:
  • Nicolas Dufresne and contributors
Copyright:
License:
  • GPL-3.0
    DuAEF is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    DuAEF is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with DuAEF. If not, see http://www.gnu.org/licenses/.

Members

static, readonly IsolationModes :int
DuAEF.jsxinc, line 31469

Modes which can be used for isolation
Properties:
Name Type Description
ALL int
VIEWPORT int
TIMELINE int

Methods

static addLayerToGroup(layer, group)
DuAEF.jsxinc, line 31485

Adds a layer to a group
Parameters:
Name Type Description
layer Layer The layer
group string The group name

static addSelectedLayersToGroup(group)
DuAEF.jsxinc, line 31501

Adds the selected layers from the current comp in the group
Parameters:
Name Type Description
group string The group name

static exitIsolation()
DuAEF.jsxinc, line 31742

Deactivates the isolation

static getGroups()
DuAEF.jsxinc, line 31685

Gets the group existing in the current comp

static getLayers(groups, invert) → {Array.<Layer>}
DuAEF.jsxinc, line 31640

Gets the layers which are in the groups
Parameters:
Name Type Description
groups Array.<string> Any combination of group names, DuAEF.DuAE.LayerTypes, DuAEF.DuAE.LayerAttributes
invert boolean When true, gets the layers which are NOT in the groups
Returns:
Array.<Layer> - The layers contained in the groups

static isolate(mode, groups)
DuAEF.jsxinc, line 31731

Activates the isolation
Parameters:
Name Type Description
mode DuAEF.Dugr.IsolationModes The mode to use
groups Array.<string> Any combination of group names, DuAEF.DuAE.LayerTypes, DuAEF.DuAE.LayerAttributes

static removeAllLayersFromGroup(group)
DuAEF.jsxinc, line 31545

Empties the group (equivalent to removing it)
Parameters:
Name Type Description
group string The group name

static removeLayerFromGroup(layer, group)
DuAEF.jsxinc, line 31520

Removes a layer from a group
Parameters:
Name Type Description
layer Layer The layer
group string The group name

static removeSelectedLayersFromGroup(group)
DuAEF.jsxinc, line 31532

Removes the selected layers in the current comp from the group
Parameters:
Name Type Description
group string The group name

static validateGroupName(name) → {int}
DuAEF.jsxinc, line 31675

Checks if the name is valid for a new group
Parameters:
Name Type Description
name string The new name to test
Returns:
int - An error code
1 - This name is ok
0 - The name is less than three letters
-1 - Contains a vertical stroke