ArcGIS Procedural Runtime  3.1.9666
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
List of all members | Public Member Functions
prt::InitialShape Class Referenceabstract

#include <InitialShape.h>

Inheritance diagram for prt::InitialShape:
[legend]

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

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

virtual AttributeMap const* prt::InitialShape::getAttributeMap ( ) const
pure virtual
Returns
AttributeMap with the initial shape's (rule) attributes.
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.
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.
virtual int32_t prt::InitialShape::getRandomSeed ( ) const
pure virtual
Returns
Random seed of the initial shape.
virtual ResolveMap const* prt::InitialShape::getResolveMap ( ) const
pure virtual
Returns
ResolveMap of the initial shape.
virtual wchar_t const* prt::InitialShape::getRuleFile ( ) const
pure virtual
Returns
URI to the rule file.
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: