Group.RemoveMember

Introduced

v5.0

Description

Removes members from the group.

C# Syntax

Boolean Group.RemoveMember( Object in_member );

Scripting Syntax

oBoolean = Group.RemoveMember( Member );

Return Value

Boolean

True if the object was successfully removed from group, and False otherwise.

Parameters

Parameter Type Description
Member XSICollection or SceneItem Members to remove.

Examples

JScript Example

NewScene(null, false );
GetPresetModel("ManSkeleton_Basic", "ManSkeletonBasic", null, null);
var group1 = ActiveSceneRoot.AddGroup();
var col = XSIFactory.CreateObject("XSI.Collection");
// add everything to the collection
col.AddItems("*");
group1.AddMember(col);
logmessage( group1.members.count );
// remove the camera and light objects
var things_to_remove = XSIFactory.CreateObject("XSI.Collection");
things_to_remove.additems( group1.members.filter("","","Camera*"));
things_to_remove.additems( group1.members.filter("","","light*"));
group1.RemoveMember(things_to_remove);
logmessage( group1.members.count );
//INFO : 54
//INFO : 50

See Also

Group.RemoveAllMembers Group.AddMember