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

A block reference is used to place, size, and display an instance of the collection of entities within a DbBlock that it references. More...

Inheritance diagram for X3g::Plugin::DbBlockReference:
Inheritance graph
[legend]

Public Member Functions

 DbBlockReference (Block^ pOwner, String^ pBlock)
 Creates a block reference to the given block. More...
 
 DbBlockReference (Block^ pOwner, Block^ pBlock)
 Creates a block reference to the given block. More...
 
 DbBlockReference (Block^ pOwner, Block^ pBlock, String^ pCustomType, Object^ pCustomObject)
 Creates a block reference to the given block. More...
 
GeMatrixGetTransform ()
 Returns transformation of the block reference. More...
 
void SetTransform (GeMatrix^ pTransform)
 Sets transformation of the block reference. More...
 
array< String^ >^ GetAttributes ()
 Returns a list of all attributes. More...
 
DbBlockReferenceCloneLinked ()
 Clones the block reference and links it with the copy. More...
 
bool OpenBlock ()
 Opens the referenced block to work with child entities (e.g. More...
 
void CloseBlock ()
 Close the referenced block and all child entities. More...
 
- Public Member Functions inherited from X3g::Plugin::DbEntity
GeMatrixGetTextureMatrix ()
 The texture matrix determines how to map the material texture to the entity. More...
 
void SetTextureMatrix (GeMatrix^ pMatrix)
 Sets the texture matrix. More...
 
bool TransformBy (GeMatrix^ pTransform)
 Transforms the entity. More...
 
GeMatrixGetTransientTransform ()
 Returns transient transformation of this entity. More...
 
void SetTransientTransform (GeMatrix^ pTransform)
 Sets the transient transformation of this entity. More...
 
void UpdateGeometry ()
 Updates the geometry of the entity. More...
 
void Delete ()
 Deletes the entity from the document. More...
 
GeBoundingBox3dGetBoundingBox (GeMatrix^ pTransform)
 Returns bounding box of entity within the owning blocks local coordinate system. More...
 
IPropertyProvider^ GetPropertyProvider ()
 Returns property provider of the entity. More...
 
DbEntityClone (Block^ pOwner)
 Creates a clone of the entity. More...
 
DbEntityCut2 (DbEntity^ pEntity)
 Subtracts pEntity from this object. More...
 
DbEntityCut2 (DbEntity^ pEntity, Block^ pToOwner)
 Subtracts pEntity from this object. More...
 
DbEntityCommon2 (DbEntity^ pEntity)
 Computes an object which represents all common geometry of this entity and pEntity. More...
 
DbEntityCommon2 (DbEntity^ pEntity, Block^ pToOwner)
 Computes an object which represents all common geometry of this entity and pEntity. More...
 
DbEntityFuse2 (DbEntity^ pEntity)
 Computes an object by merging all geometry of this entity and pEntity. More...
 
DbEntityFuse2 (DbEntity^ pEntity, Block^ pToOwner)
 Computes an object by merging all geometry of this entity and pEntity. More...
 
List< DbEntity^ >^ Slice (GePlane^ pPlane, bool pKeepBothHalves)
 Slice the DbEntity with the plane. More...
 
DbEntityPartialMove (GePlane^ pPlane, double pLength)
 Strech or shrink the DbEntity at the given plane. More...
 
void AddCallbacks (DbEntityCallbacks^ pCallbacks)
 Add callbacks to the entity. More...
 
void RemoveCallbacks (DbEntityCallbacks^ pCallbacks)
 Remove callbacks from entity. More...
 

Properties

String^  Block [get, set]
 The referenced block, identified by the block name. More...
 
GeVec3d Position [get, set]
 Position of this block reference. More...
 
GeQuat Rotation [get, set]
 Rotation of this block reference. More...
 
GeVec3d Scale [get, set]
 Scale of this block reference. More...
 
bool IsBlockOpen [get]
 Returns true if the referenced block is open for edit. More...
 
- Properties inherited from X3g::Plugin::DbEntity
String^  Id [get]
 The unqiue id of the entity. More...
 
String^  Name [get, set]
 User-defined name of the entity. More...
 
String^  Material [get, set]
 Material of this entity. More...
 
EntityColor Color [get, set]
 Color of this entity. More...
 
String^  Layer [get, set]
 Layer name of this entity. More...
 
String^  OwningBlock [get]
 Name of the block that owns this entity. More...
 
bool TopLevel [get]
 Returns if entity is owned by modelspace. More...
 
bool Valid [get]
 Returns if entity is valid and not erased. More...
 
DbTextureProjection TextureProjection [get, set]
 The AutoCAD texture projection. More...
 
bool IsModelingSupported [get]
 If true the entity can be used with modeling functions. More...
 
bool Locked [get, set]
 Lock status of this entity. More...
 
GeVec2d LayoutPosition [get, set]
 Position the Entity in Layout. More...
 
DbDictionary^  CustomData [get]
 Allows to attach custom data to the entity. More...
 
String^  CustomType [get, set]
 Allows plugins to identify their entities. More...
 
Object^  CustomObject
 Allows to attach an object which extents the entity (e.g. More...
 
bool IsVisible [get, set]
 Visibility of this entity. More...
 
Hyperlink Link [get, set]
 Get or Set the Hyperlink attached to the DbEntity. More...
 

Events

System::EventHandler^  IsBlockOpenChanged
 Occurs when DbBlockReference::IsBlockOpen changed. More...
 
- Events inherited from X3g::Plugin::DbEntity
System::EventHandler^  VisibilityChanged
 Occurs when DbEntity::IsVisible changed. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from X3g::Plugin::DbEntity
static DbEntityFromId (String^ pEntityId)
 Creates DbEntity to given entity id. More...
 
- Package Functions inherited from X3g::Plugin::DbEntity
 DbEntity (Block^ pOwner, EntityImpl *pImpl)
 This constructor is used to create new OdDbEntities and add to a block. More...
 
 DbEntity (Layout::Page^ pPage, EntityImpl *pImpl)
 This constructor is used to create new OdDbEntities and add to a page. More...
 

Detailed Description

A block reference is used to place, size, and display an instance of the collection of entities within a DbBlock that it references.

In addition, block references can be the owner of DbAttribute entities.

Constructor & Destructor Documentation

X3g::Plugin::DbBlockReference::DbBlockReference ( Block pOwner,
String pBlock 
)

Creates a block reference to the given block.

X3g::Plugin::DbBlockReference::DbBlockReference ( Block pOwner,
Block pBlock 
)

Creates a block reference to the given block.

X3g::Plugin::DbBlockReference::DbBlockReference ( Block pOwner,
Block pBlock,
String pCustomType,
Object^  pCustomObject 
)

Creates a block reference to the given block.

Allows to set custom type and custom object on construction.

Member Function Documentation

DbBlockReference X3g::Plugin::DbBlockReference::CloneLinked ( )

Clones the block reference and links it with the copy.

When user changes block content of one reference the linked references will also be changed. If block references are not linked the blocks would be made unique in this case. Linked block references are only supported in modelspace.

Exceptions
System::NotSupportedExceptionBlock reference not in modelspace.
void X3g::Plugin::DbBlockReference::CloseBlock ( )

Close the referenced block and all child entities.

array< String^ > X3g::Plugin::DbBlockReference::GetAttributes ( )

Returns a list of all attributes.

Use DbEntity::FromId() to retrieve the DbAttribute behind it's id.

GeMatrix X3g::Plugin::DbBlockReference::GetTransform ( )

Returns transformation of the block reference.

bool X3g::Plugin::DbBlockReference::OpenBlock ( )

Opens the referenced block to work with child entities (e.g.

select, edit). Returns true on success.

The parent block of this entity must be the modelspace or already open. Other DbBlockReferences at the same level will be closed. Attention: The block of this reference maybe cloned on open to avoid editing multiple references at one.

void X3g::Plugin::DbBlockReference::SetTransform ( GeMatrix pTransform)

Sets transformation of the block reference.

Property Documentation

String^ X3g::Plugin::DbBlockReference::Block
getset

The referenced block, identified by the block name.

Use IBlockManager::GetBlock() to retrieve the block interface.

bool X3g::Plugin::DbBlockReference::IsBlockOpen
get

Returns true if the referenced block is open for edit.

GeVec3d X3g::Plugin::DbBlockReference::Position
getset

Position of this block reference.

GeQuat X3g::Plugin::DbBlockReference::Rotation
getset

Rotation of this block reference.

GeVec3d X3g::Plugin::DbBlockReference::Scale
getset

Scale of this block reference.

Event Documentation

System:: EventHandler^ X3g::Plugin::DbBlockReference::IsBlockOpenChanged

Occurs when DbBlockReference::IsBlockOpen changed.