<     > 

BranchFlag (ProjectItem) *

Description

Returns or sets the branch flag using one of the siBranchFlag enum values. The branch flag indicates whether an object was added to a Group or to the Selection in branch mode.

Note: You cannot change a group member to branch mode by changing the branch flag. You must remove the member and then add it in branch mode.

C# Syntax

// get accessor
siBranchFlag rtn = ProjectItem.BranchFlag;

// set accessor
ProjectItem.BranchFlag = siBranchFlag;

Examples

JScript Example

NewScene( null, false );
var a = Application.ActiveSceneRoot.AddGeometry( "Cube", "MeshSurface", "A" );
a.length.Value = 2;

var b = a.AddGeometry( "Cube", "MeshSurface", "B" );
b.length.Value = 2;
Translate( b, 5 );

var c = b.AddGeometry( "Cube", "MeshSurface", "C" );
c.length.Value = 2;
Translate( c, 5 );

// Create group
var group = Application.ActiveSceneRoot.AddGroup();

// Add members to group
group.AddMember( a, true );
group.AddMember( b, false );

Application.LogMessage( "Number of group members : " + group.members.Count );

// Determine which members were added in branch mode
for ( var i = 0; i < group.Members.Count; i++ )
{
   var member = group.Members(i);

   var bBranchMember = group.Members(i).BranchFlag ? "true" : "false";
   Application.LogMessage( member + " added in branch mode? " + bBranchMember );
}

// Expected results:
//INFO : Number of group members : 2
//INFO : A added in branch mode? true
//INFO : B added in branch mode? false

SOFTIMAGE|XSI v6.01     <     >