Class LayerProperty
See Also: Class ReferenceTarget, Class ILayerManager.
class LayerProperty : public ReferenceTarget
Description:
This class is available in release 3.0 and later only.
The methods of this class are currently unused and reserved for internal use as of release 3.0.
class LayerProperty : public ReferenceTarget
Methods:
public:
Prototype:
LayerProperty();
Remarks:
Constructor.
This will set the layer ID to -1 and an empty name string.
Default Implementation:
{ }
Prototype:
LayerProperty(const TSTR & name, int id);
Remarks:
Constructor.
This will initialize the layer property with the name and ID of the property.
Default Implementation:
{ }
Prototype:
virtual ~LayerProperty();
Remarks:
Destructor.
Default Implementation:
{ }
Prototype:
virtual void SetProperty(const int d) = 0;
Remarks:
This method allows you to set the integer property.
Parameters:
const int d
The property to set.
Prototype:
virtual void SetProperty(const float d) = 0;
Remarks:
This method allows you to set the floating point property.
Parameters:
const float d
The property to set.
Prototype:
virtual void SetProperty(const Point3 & d) = 0;
Remarks:
This method allows you to set the Point3 property.
Parameters:
const Point3 & d
The property to set.
Prototype:
virtual void SetProperty(const TSTR & d) = 0;
Remarks:
This method allows you to set the string property.
Parameters:
const TSTR & d
The property to set.
Prototype:
virtual void SetProperty(void * d) = 0;
Remarks:
This method allows you to set the property.
Parameters:
void * d
A pointer to the property data to set.
Prototype:
virtual bool GetProperty(int & i) const = 0;
Remarks:
This method returns the layer property.
Parameters:
int & i
The property data.
Return Value:
TRUE if successful, otherwise FALSE.
Prototype:
virtual bool GetProperty(float & f) const = 0;
Remarks:
This method returns the layer property.
Parameters:
float & f
The property data.
Return Value:
TRUE if successful, otherwise FALSE.
Prototype:
virtual bool GetProperty(Point3 & p) const = 0;
Remarks:
This method returns the layer property.
Parameters:
Point3 & p
The property data.
Return Value:
TRUE if successful, otherwise FALSE.
Prototype:
virtual bool GetProperty(TSTR & n) const = 0;
Remarks:
This method returns the layer property.
Parameters:
TSTR & n
The property data.
Return Value:
TRUE if successful, otherwise FALSE.
Prototype:
virtual bool GetProperty(void * v) const = 0;
Remarks:
This method returns the layer property.
Parameters:
void * v
The property data.
Return Value:
TRUE if successful, otherwise FALSE.
Prototype:
int GetID() const;
Remarks:
This method returns the property ID.
Prototype:
void SetID(int id);
Remarks:
This method allows you to set the property ID.
Parameters:
int id
The ID to set.
Prototype:
TSTR GetName() const;
Remarks:
This method returns the property name.
Prototype:
void SetName(const TSTR & name);
Remarks:
This method allows you to set the property name.
Parameters:
const TSTR & name
The property name to set.