hgl 0.5.25
A compiler/interpreter suite for developing images
Public Member Functions | Protected Member Functions | List of all members
HGL::Type::Poly Class Reference

#include "poly.h"

Inheritance diagram for HGL::Type::Poly:
[legend]

Public Member Functions

const FillgetFill () const
 Gets the Fill type of the type. More...
 
virtual bool isValid () const
 Checks if the type is valid. More...
 
- Public Member Functions inherited from HGL::Type::ReferenceHolderBase
virtual const ITypefindReference (bool recache=false) const
 Searches the tree for the associated reference. More...
 
virtual const std::string * getReference () const
 Gets the reference. More...
 
virtual void setReference (const std::string &ref, bool fromStdLib=false)
 Sets the reference. More...
 
Reference access and manipulation
- Public Member Functions inherited from HGL::IType
virtual operator iterator ()=0
 Gets the iterator over this type's attached types. More...
 
- Public Member Functions inherited from HGL::Type::TypeBase
ITypeattachType (IType *type, bool check=true) throw (Exception::AttachException)
 Attach child objects to the IType at end of list. More...
 
virtual IType::iterator begin ()
 Gets the iterator to the begin over this type's attached types. More...
 
virtual IType::iterator end ()
 Gets the iterator to the end over this type's attached types. More...
 
virtual const TYPELISTgetAttachedTypes () const
 Returns all attached IType instances. More...
 
virtual const std::string & getId () const
 Gets the identifier. More...
 
virtual ITypegetParent () const
 Returns the parent IType. More...
 
virtual bool isNull () const
 Checks if the type is null type. More...
 
virtual void setDescription (const std::string &desc)
 Sets the description of the type. More...
 
virtual void setId (const std::string &id)
 Sets the identifier. More...
 

Protected Member Functions

virtual ITypeattachType (IType *type, const HGL::IType::TYPELIST::iterator &before, bool check) throw (Exception::AttachException)
 
virtual void detachType (IType *type)
 Detaches a child from the IType. More...
 
virtual SERIALID getSerialID () const
 Gets the SerialID of HGL::IType::SPOLY More...
 
- Protected Member Functions inherited from HGL::Type::TypeBase
virtual ITypeattachType (IType *type, const TYPELIST::iterator &before, bool check=true) throw (Exception::AttachException)
 Attaches a child at the position before. More...
 
virtual IType::Ptr clone () const throw (Exception::CloneNotSupportedException)
 Creates a clone of the type. More...
 
virtual const std::string & getDescription () const
 Gets the description of the type. More...
 
virtual const ITypegetRoot (const IType &type) const
 Get the root of a type. More...
 
virtual std::string getTypeName () const
 Displayable name of the IType. More...
 
virtual operator float () const throw (Exception::ReferenceException, Exception::InvalidExpressionException)
 Converts the type into a float More...
 
virtual ITyperesolve (const std::string &id) const
 Resolves a type by its ID. More...
 
virtual void setParent (IType *parent)
 Set parent of the type. More...
 

Detailed Description

Author
Heiko Schäfer heiko.nosp@m.@hgl.nosp@m..rang.nosp@m.un.d.nosp@m.e

Member Function Documentation

HGL::IType * Poly::attachType ( IType type,
const HGL::IType::TYPELIST::iterator &  before,
bool  check 
)
throw (Exception::AttachException
)
protectedvirtual
void Poly::detachType ( IType type)
protectedvirtual

Detaches a child from the IType.

Parameters
typethe IType to detach
Since
0.5.21

Reimplemented from HGL::Type::TypeBase.

References HGL::Type::TypeBase::detachType().

const Fill * Poly::getFill ( ) const
virtual

Gets the Fill type of the type.

Returns the last attached type if it is a Fill type

See Also
Poly::isValid
Returns
a Fill or NULL if none available

Implements HGL::Type::IFillable.

References HGL::Type::TypeBase::getAttachedTypes().

HGL::IType::SERIALID Poly::getSerialID ( ) const
protectedvirtual

Gets the SerialID of HGL::IType::SPOLY

Returns
HGL::IType::SPOLY

Implements HGL::IType.

Reimplemented in HGL::Type::Curve.

References HGL::IType::SPOLY.

bool Poly::isValid ( ) const
virtual

Checks if the type is valid.

To be a valid Poly the Fill, if attached, must be the last attached type and it must contain at least two valid attached types.

Note
This method returns true if a reference is set, but not checking if the reference itself is valid. A type is valid
  1. if all attached types are allowed for this type, if not the type is invalid
  2. if all attached types itself are valid, if not the type is invalid

Subclasses can add more checks if neccessary.

Returns
true if the type is valid, false otherwise

Reimplemented from HGL::Type::ReferenceHolderBase.

Reimplemented in HGL::Type::Curve.

References HGL::Type::TypeBase::getAttachedTypes(), and HGL::Type::ReferenceHolderBase::isValid().