pCon.planner Plugin SDK  Version 8.8.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | Public Attributes | Properties | List of all members
X3g::Plugin::Block Class Reference

Blocks are containers for entities within a planning. More...

Public Member Functions

IList< DbEntity^ >^ CloneEntities (IEnumerable< DbEntity^ >^pEntities)
 Adds clones of given entities to this block. More...
 
IList< DbBlockReference^ >^ GetReferences (bool pDirectOnly)
 Returns all references to this block. More...
 
IList< DbEntity^ >^ GetEntities ()
 Returns all entities which are owned by this block. More...
 
IList< DbEntity^ >^ GetEntities (System::String^ pCustomType)
 Returns all entities which are owned by this block and have the given custom type. More...
 

Public Attributes

template<typename T >
where T: DbEntity IList<T>^ GetEntities() { List<T>^ entities = gcnew List<T>()
 Returns all entities of given type which are owned by this block. More...
 

Properties

String^  Name [get, set]
 The unique name of the block. More...
 
GeVec3d Origin [get, set]
 Base point of the block in WCS coordinates. More...
 
bool IsModelSpace [get]
 Returns if this block is the modelspace block. More...
 

Detailed Description

Blocks are containers for entities within a planning.

They own all entities they contain. There are two special Blocks that are always present in every planning: "*MODEL_SPACE" and "*PAPER_SPACE", where the model space is the block that contains all "top level" entities of the 3D space in the planner.

Member Function Documentation

IList< DbEntity^ > X3g::Plugin::Block::CloneEntities ( IEnumerable< DbEntity^ >^  pEntities)

Adds clones of given entities to this block.

Returns the clones.

IList< X3g::Plugin::DbEntity^ > X3g::Plugin::Block::GetEntities ( )

Returns all entities which are owned by this block.

IList< X3g::Plugin::DbEntity^ > X3g::Plugin::Block::GetEntities ( System::String^  pCustomType)

Returns all entities which are owned by this block and have the given custom type.

IList< DbBlockReference^ > X3g::Plugin::Block::GetReferences ( bool  pDirectOnly)

Returns all references to this block.

If pDirectOnly is false it also returns references to blocks which own direct or indirect references to this block.

Member Data Documentation

template<typename T >
where X3g::Plugin::Block::T

Returns all entities of given type which are owned by this block.

Property Documentation

bool X3g::Plugin::Block::IsModelSpace
get

Returns if this block is the modelspace block.

String^ X3g::Plugin::Block::Name
getset

The unique name of the block.

GeVec3d X3g::Plugin::Block::Origin
getset

Base point of the block in WCS coordinates.