Vg3DModule::VgLine Class Reference

A VgLine is created using Vg3DModule::VgInstanceFactory::instantiate. More...

Inheritance diagram for Vg3DModule::VgLine:

Collaboration diagram for Vg3DModule::VgLine:

List of all members.

Public Types
typedef VgLineDescriptor	Descriptor
Public Member Functions
virtual VgEngine::VgConstRefPtr < Descriptor >	getDescriptor () const
	Retrieves the descriptor containing line information.
virtual Vg3DModule::VgIGeometryType	getType () const
Protected Member Functions
	VgLine ()
	Constructor.
virtual	~VgLine ()
	Destructor.
Friends
class	VgEngine::VgInstanceFactory
class	VgEngine::VgObjectBridge

---

Detailed Description

A VgLine is created using Vg3DModule::VgInstanceFactory::instantiate.

Once created, it may be added to a layer using VgLine::setLayer.

     ...
     VgApplication::VgIApplication* mVgApplication;
     Vg3DModule::VgLineDescriptor lLineDesc;
     ...

     VgEngine::VgRefPtr< Vg3DModule::VgLine > lLine = mVgApplication->editEngine()->editInstanceFactory()->instantiate(lLineDesc);
     
     const VgEngine::VgLayerManager::LayerList& lLayers = mVgApplication->editEngine()->editLayerManager()->getLayers();
     
     // Choose the first layer.
     VgEngine::VgRefPtr< VgEngine::VgLayer > lLayer = lLayers.at(0);
     
     // Note: The line will only be seen if it's associated layer is visible.
     lLine->setLayer(lLayer);
     
     // To remove the line from the layer 
     lLine->setLayer(NULL);
     
     // If the line is no longer required, then release it's memory.
     // VgLine is reference counted, so just null-out the VgRefPtr.
     lLine = NULL;

Version:

2.0

---

Member Typedef Documentation

typedef VgLineDescriptor Vg3DModule::VgLine::Descriptor

---

Constructor & Destructor Documentation

Vg3DModule::VgLine::VgLine

(

)

[protected]

Constructor.

virtual Vg3DModule::VgLine::~VgLine

(

)

[protected, virtual]

Destructor.

---

Member Function Documentation

virtual VgEngine::VgConstRefPtr< Descriptor > Vg3DModule::VgLine::getDescriptor

(

)

const [virtual]

Retrieves the descriptor containing line information.

Returns:

The descriptor.

virtual Vg3DModule::VgIGeometryType Vg3DModule::VgLine::getType

(

)

const [virtual]

Returns:

The geometry type for this object

Reimplemented from Vg3DModule::VgIGeometry.

---

Friends And Related Function Documentation

friend class VgEngine::VgInstanceFactory [friend]

friend class VgEngine::VgObjectBridge [friend]

Reimplemented from Vg3DModule::VgIGeometry.

---

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

• VgLine.h