prt::InitialShape Class Reference

#include <InitialShape.h>

Inheritance diagram for prt::InitialShape:

Public Member Functions
virtual AttributeMap const *	getAttributeMap () const =0
virtual wchar_t const *	getCacheKey () const =0
virtual wchar_t const *	getName () const =0
virtual int32_t	getRandomSeed () const =0
virtual ResolveMap const *	getResolveMap () const =0
virtual wchar_t const *	getRuleFile () const =0
virtual wchar_t const *	getStartRule () const =0
Public Member Functions inherited from prt::Object
void	destroy () const
virtual char *	toXML (char *result, size_t *resultSize, Status *stat=0) const =0
char *	toXMLDocument (char *result, size_t *resultSize, Status *stat=0) const

Additional Inherited Members
Protected Member Functions inherited from prt::Object
	Object (const Object &)

Detailed Description

An InitialShape is the fundamental input for the generation of a procedural model. It contains

• a geometry (1D (e.g. a point), 2D (e.g. a building footprint) or 3D (e.g. a building mass model)
• a rule file (a cgb file compiled from a cga rule)
• a start rule (which must be defined in the rule file)
• a random seed
• a number of values for named (rule) attributes
• a resolve map, used for resolving symbolic asset names ("keys") to real URIs

All the above members are mandatory, i.e. must be set, and directly control the generation of the procedural model.

See also

generate(), InitialShapeBuilder

Member Function Documentation

getAttributeMap()

virtual AttributeMap const* prt::InitialShape::getAttributeMap ( ) const

pure virtual

Returns

AttributeMap with the initial shape's (rule) attributes.

getCacheKey()

virtual wchar_t const* prt::InitialShape::getCacheKey ( ) const

pure virtual

Returns a unique string which can be used for caching purposes. By default returns a memory URI of the InitialShape instance. Can be user-defined by setting the string attribute "/cache/key". Is used as cache key for shapetree caching.

Returns

Cache key of the initial shape.

getName()

virtual wchar_t const* prt::InitialShape::getName ( ) const

pure virtual

The name can be any string, i.e. must not be unique!

Returns

Name of the initial shape.

getRandomSeed()

virtual int32_t prt::InitialShape::getRandomSeed ( ) const

pure virtual

Returns

Random seed of the initial shape.

getResolveMap()

virtual ResolveMap const* prt::InitialShape::getResolveMap ( ) const

pure virtual

Returns

ResolveMap of the initial shape.

getRuleFile()

virtual wchar_t const* prt::InitialShape::getRuleFile ( ) const

pure virtual

Returns

URI to the rule file.

getStartRule()

virtual wchar_t const* prt::InitialShape::getStartRule ( ) const

pure virtual

Returns

Name of the start rule.

---

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

• InitialShape.h