SilverScreen Solid Modeler

BosList.FromDescendants method

BosList.FromDescendants method

Previous topic Next topic  

BosList.FromDescendants method

Previous topic Next topic JavaScript is required for the print function  

SilverSharpAPI

 

public static BosList FromDescendants(string block_path)

public static BosList FromDescendants(BLOCK_NODE block)

 

string block_path;   // A System.String

BLOCK_NODE block;    // A SilverSharp.BLOCK_NODE

 

 




Synopsis

The FromDescendants methods return a BosList class that will enumerate all of the children and their descendants of a block.

 

 

Parameters

block_path is a string that is a SilverScreen path to a block entity

block is a SilverSharp.BLOCK_NODE whose children are to be retrieved

 

 

Return Value

FromDescendants returns a BosList class

 

 

Remarks

This function retrieves all children and their descendants of a block entity. In the familial parlance, it will  retrieve children as well as grand children.

 

 

See Also

BosList, FromChildren

 

 

Example

To visit all of the descendants of a block entity, do this:

C# Code

 

 using SilverSharp;

 

 . . .

 

 BosList bl = BosList.FromDescendants("\\assembly\\a1");

   

 foreach ( BOS_NODE bos in bl )

    {

    VisitOneBos(bos);

    }