Vg3DModule::VgLink Class Reference

This class displays a 'ribbon' that links to positions in the scene. More...

Inheritance diagram for Vg3DModule::VgLink:

Public Types
typedef VgLinkDescriptor	Descriptor

Public Member Functions
virtual	~VgLink ()
	Destructor. More...
void	setVisible (bool pIsVisible)
	Sets the link's visibility. More...
Public Member Functions inherited from VgEngine::VgReferenced
	VgReferenced ()
	Constructor. More...
	VgReferenced (const VgReferenced &pThis)
	Copy constructor. More...
virtual	~VgReferenced ()
	Destructor. More...
VgReferenced &	operator= (const VgReferenced &pThis)
	Assignment operator. More...
void	ref () const
	This method is used to add a reference to this object. More...
int	unref () const
	This method is used to remove a reference to this object. More...
int	getNbReferences () const
	Retrieves the number of references to this object. More...

Friends
class	VgEngine::VgInstanceFactory
class	VgEngine::VgObjectBridge

Additional Inherited Members
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences
	The number of references to this object. More...

Detailed Description

This class displays a 'ribbon' that links to positions in the scene.

The advantage of using a link rather than a line, is that the start and end positions will be updated when their SRS changes (usually different layers). It is particularly usefull when we want to link positions 'hooked' to layers while they are animated around.

Remarks

The application needs to keep a reference to the VgLink, otherwise the VgLink will be removed when the last reference from the application is destroyed.

Version

2.0

2.1.3 Updated documentation with note about keeping reference in application to avoid removing link.

Member Typedef Documentation

typedef VgLinkDescriptor Vg3DModule::VgLink::Descriptor

Constructor & Destructor Documentation

virtual Vg3DModule::VgLink::~VgLink ( )

virtual

Destructor.

Member Function Documentation

void Vg3DModule::VgLink::setVisible

(

bool

pIsVisible

)

Sets the link's visibility.

Parameters

pIsVisible

If true, the link will be visible, if false the link will be invisible

Friends And Related Function Documentation

friend class VgEngine::VgInstanceFactory

friend

friend class VgEngine::VgObjectBridge

friend

---

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

• VgLink.h