Itasca C++ Interface
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
zone::IAttachList Class Referenceabstract

Interface for accessing the global list of attachments, IAttachPoint. More...

#include <iattachlist.h>

Public Member Functions

virtual const IThinggetIThing () const =0
 returns a const IThing pointer
 
virtual IThinggetIThing ()=0
 returns a IThing pointer
 
virtual const IContainergetIContainer () const =0
 Returns a const pointer to the IContainer interface representing the global list of attachments.
 
virtual IContainergetIContainer ()=0
 Returns a pointer to the IContainer interface representing the global list of attachments.
 
virtual uint32 getAttachType () const =0
 Returns the attachment type for the TypeEntry system.
 
virtual const IAttachPointgetFirstAttach () const =0
 
virtual IAttachPointgetFirstAttach ()=0
 
virtual const IAttachPointfindAttachWithID (uint64 id) const =0
 Returns a pointer to the attachment, IAttachPoint, that matches id.
.
 
virtual uint32 getAttachPointNotice () const =0
 Returns the notification code for attachments.
 
virtual IAttachPointcreateAttach (IAttachPoint::ClassType type, IGp *follower, IThing *it1, IThing *it2, uint32 faceNo, bool snap)=0
 

Static Public Attributes

static const TType type_ = 0x4e5d11ef
 The type identification number for this class, for use in convert_cast() and convert_getcast().
 

Detailed Description

Interface for accessing the global list of attachments, IAttachPoint.

Member Function Documentation

◆ createAttach()

virtual IAttachPoint * zone::IAttachList::createAttach ( IAttachPoint::ClassType type,
IGp * follower,
IThing * it1,
IThing * it2,
uint32 faceNo,
bool snap )
pure virtual

Creates an attachment

Parameters
typeis the attachment type (gridpoint, edge or face)
followeris the the follower gridpoint
it1,it2,faceNoFor attachment type gridpoint it1 is the leader gridpoint. Parameters it2 and faceNo are not used. For type edge, it1 and it2 are the gridpoint pointers that form of the edge. Parameter faceNo is not used. For type face, it1 is the zone pointer, it2 is not used. faceNo is the face number, valid values are 0 to 5.
snapsee ATTACH command reference for behavior.

◆ getFirstAttach() [1/2]

virtual const IAttachPoint * zone::IAttachList::getFirstAttach ( ) const
pure virtual

Returns a const pointer to the first attachment, IAttachPoint, in the list, or 0 if list is empty. Use in conjunction with IAttachPoint::getNext();

◆ getFirstAttach() [2/2]

virtual IAttachPoint * zone::IAttachList::getFirstAttach ( )
pure virtual

Returns a pointer to the first attachment, IAttachPoint, in the list, or 0 if list is empty.
Use in conjunction with IAttachPoint::getNext();


The documentation for this class was generated from the following file: