GroupTable.Add (IEnumerable.Guid.)

Public Class

Adds a new group to the group table with a set of objects.

Namespace: Rhino.DocObjects.Tables

Assembly: RhinoCommon (in RhinoCommon.dll)

**Since:**5.0

Syntax

public int Add(
  IEnumerable<Guid> objectIds
)

Parameters

objectIds

Type:System.Collections.Generic.IEnumerable.Guid.
An array, a list or any enumerable set of object IDs.

Return Value

Type:Int32
\>=0 index of new group.

-1 group not added because a group with that name already exists.

Remarks

In some cases, calling Add() can cause the group indices to become invalid.

Examples

using System;
using System.Collections.Generic;

partial class Examples
{
  public static Rhino.Commands.Result AddObjectsToGroup(Rhino.RhinoDoc doc)
  {
    Rhino.Input.Custom.GetObject go = new Rhino.Input.Custom.GetObject();
    go.SetCommandPrompt("Select objects to group");
    go.GroupSelect = true;
    go.GetMultiple(1, 0);
    if (go.CommandResult() != Rhino.Commands.Result.Success)
      return go.CommandResult();

    List<Guid> ids = new List<Guid>();
    for (int i = 0; i < go.ObjectCount; i++)
    {
      ids.Add(go.Object(i).ObjectId);
    }
    int index = doc.Groups.Add(ids);
    doc.Views.Redraw();
    if (index >= 0)
      return Rhino.Commands.Result.Success;
    return Rhino.Commands.Result.Failure;
  }
}

import Rhino
import scriptcontext

def AddObjectsToGroup():
    go = Rhino.Input.Custom.GetObject()
    go.SetCommandPrompt("Select objects to group")
    go.GroupSelect = True
    go.GetMultiple(1, 0)
    if go.CommandResult()!=Rhino.Commands.Result.Success:
        return go.CommandResult()

    ids = [go.Object(i).ObjectId for i in range(go.ObjectCount)]
    index = scriptcontext.doc.Groups.Add(ids)
    scriptcontext.doc.Views.Redraw()
    if index>=0: return Rhino.Commands.Result.Success
    return Rhino.Commands.Result.Failure

if __name__ == "__main__":
    AddObjectsToGroup()