Detailed Description

Definition at line 128 of file WeberPennTree.py.

Public Member Functions
	__init__ (self, Context context)

	__enter__ (self)

	__exit__ (self, exc_type, exc_value, traceback)

	__del__ (self)
	Destructor to ensure C++ resources freed even without 'with' statement.

	getNativePtr (self)

int	buildTree (self, wpt_type, vec3 origin=vec3(0, 0, 0), float scale=1)
	Build a tree using either a built-in tree type or custom species name.

List[int]	getTrunkUUIDs (self, int tree_id)

List[int]	getBranchUUIDs (self, int tree_id)

List[int]	getLeafUUIDs (self, int tree_id)

List[int]	getAllUUIDs (self, int tree_id)

None	setBranchRecursionLevel (self, int level)

None	setTrunkSegmentResolution (self, int trunk_segs)

None	setBranchSegmentResolution (self, int branch_segs)

None	setLeafSubdivisions (self, int leaf_segs_x, int leaf_segs_y)

None	loadXML (self, str filename, bool silent=False)
	Load custom tree species from XML file.

Public Attributes
	context = context

	wpt

Static Public Attributes
	WPTType = WPTType

Protected Attributes
	_plugin_registry = get_plugin_registry()

Constructor & Destructor Documentation

◆ init()

pyhelios.WeberPennTree.WeberPennTree.__init__	(		self,
		Context	context )

Definition at line 131 of file WeberPennTree.py.

◆ del()

pyhelios.WeberPennTree.WeberPennTree.__del__ ( self )

Destructor to ensure C++ resources freed even without 'with' statement.

Definition at line 191 of file WeberPennTree.py.

Member Function Documentation

◆ enter()

pyhelios.WeberPennTree.WeberPennTree.__enter__ ( self )

Definition at line 180 of file WeberPennTree.py.

◆ exit()

pyhelios.WeberPennTree.WeberPennTree.__exit__	(	self,
		exc_type,
		exc_value,
		traceback )

Definition at line 183 of file WeberPennTree.py.

◆ buildTree()

int pyhelios.WeberPennTree.WeberPennTree.buildTree	(		self,
			wpt_type,
		vec3	origin = vec3(0, 0, 0),
		float	scale = 1 )

Build a tree using either a built-in tree type or custom species name.

Parameters

wpt_type	Either WPTType enum for built-in types, or string for custom species loaded via loadXML()
origin	Tree origin position (default: vec3(0, 0, 0))
scale	Tree scale factor (default: 1.0)

Returns: Tree ID for querying tree components

Definition at line 215 of file WeberPennTree.py.

◆ getAllUUIDs()

List[int] pyhelios.WeberPennTree.WeberPennTree.getAllUUIDs	(		self,
		int	tree_id )

Definition at line 262 of file WeberPennTree.py.

◆ getBranchUUIDs()

List[int] pyhelios.WeberPennTree.WeberPennTree.getBranchUUIDs	(		self,
		int	tree_id )

Definition at line 250 of file WeberPennTree.py.

◆ getLeafUUIDs()

List[int] pyhelios.WeberPennTree.WeberPennTree.getLeafUUIDs	(		self,
		int	tree_id )

Definition at line 256 of file WeberPennTree.py.

◆ getNativePtr()

pyhelios.WeberPennTree.WeberPennTree.getNativePtr ( self )

Definition at line 200 of file WeberPennTree.py.

◆ getTrunkUUIDs()

List[int] pyhelios.WeberPennTree.WeberPennTree.getTrunkUUIDs	(		self,
		int	tree_id )

Definition at line 244 of file WeberPennTree.py.

◆ loadXML()

None pyhelios.WeberPennTree.WeberPennTree.loadXML	(		self,
		str	filename,
		bool	silent = False )

Load custom tree species from XML file.

   Loads tree species definitions from an XML file into the WeberPennTree library.
   After loading, trees can be built using buildTree() with the custom species names
   defined in the XML file.

Parameters

filename	Path to XML file containing tree species definitions. Can be absolute or relative to current working directory.
silent	If True, suppress console output during loading. Default False.

Exceptions

ValueError	If filename is invalid or empty
FileNotFoundError	If XML file does not exist
HeliosRuntimeError	If XML file is malformed or cannot be parsed

Example: >>> wpt = WeberPennTree(context) >>> wpt.loadXML("my_custom_trees.xml") >>> tree_id = wpt.buildTree("CustomOak") # Use custom species name

Note: XML file must follow WeberPennTree XML schema. See WeberPennTreeLibrary.xml in helios-core/plugins/weberpenntree/xml/ for format examples.

Definition at line 318 of file WeberPennTree.py.

◆ setBranchRecursionLevel()

None pyhelios.WeberPennTree.WeberPennTree.setBranchRecursionLevel	(		self,
		int	level )

Definition at line 268 of file WeberPennTree.py.

◆ setBranchSegmentResolution()

None pyhelios.WeberPennTree.WeberPennTree.setBranchSegmentResolution	(		self,
		int	branch_segs )

Definition at line 280 of file WeberPennTree.py.

◆ setLeafSubdivisions()

None pyhelios.WeberPennTree.WeberPennTree.setLeafSubdivisions	(		self,
		int	leaf_segs_x,
		int	leaf_segs_y )

Definition at line 286 of file WeberPennTree.py.

◆ setTrunkSegmentResolution()

None pyhelios.WeberPennTree.WeberPennTree.setTrunkSegmentResolution	(		self,
		int	trunk_segs )

Definition at line 274 of file WeberPennTree.py.

Member Data Documentation

◆ _plugin_registry

pyhelios.WeberPennTree.WeberPennTree._plugin_registry = get_plugin_registry()

protected

Definition at line 133 of file WeberPennTree.py.

◆ context

pyhelios.WeberPennTree.WeberPennTree.context = context

Definition at line 132 of file WeberPennTree.py.

◆ wpt

pyhelios.WeberPennTree.WeberPennTree.wpt

Initial value:

=  wpt_wrapper.createWeberPennTreeWithBuildPluginRootDirectory(
                context.getNativePtr(), str(build_dir)
            )

Definition at line 174 of file WeberPennTree.py.

◆ WPTType

pyhelios.WeberPennTree.WeberPennTree.WPTType = WPTType

static

Definition at line 129 of file WeberPennTree.py.

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

pyhelios/WeberPennTree.py