App DocumentObject - Revision history

LabRPS: /* Introduction */

2024-10-30T17:02:52Z

Introduction

← Older revision		Revision as of 10:02, 30 October 2024
Line 8:		Line 8:

	[[File:LabRPS_core_objects.svg\|1024px]]		[[File:LabRPS_core_objects.svg\|1024px]]

	{{Caption\|Simplified diagram of the relationships between the core objects in LabRPS}}		{{Caption\|Simplified diagram of the relationships between the core objects in LabRPS}}

LabRPS: /* Introduction */

2024-10-30T17:01:59Z

Introduction

← Older revision		Revision as of 10:01, 30 October 2024
Line 7:		Line 7:
	In general terms, a "DocumentObject" is any "thing" that can appear in the [[Tree_view\|Tree view]], and which is saved and restored when opening a document.		In general terms, a "DocumentObject" is any "thing" that can appear in the [[Tree_view\|Tree view]], and which is saved and restored when opening a document.

	[[File:LabRPS_core_objects.svg\|~~800px~~]]		[[File:LabRPS_core_objects.svg\|1024px]]

	{{Caption\|Simplified diagram of the relationships between the core objects in LabRPS}}		{{Caption\|Simplified diagram of the relationships between the core objects in LabRPS}}

LabRPS at 16:12, 28 October 2024

2024-10-28T16:12:35Z

← Older revision		Revision as of 09:12, 28 October 2024
Line 18:		Line 18:
	* The [[App_FeaturePython\|App FeaturePython]] class, an empty object that can be used for different purposes, depending on the added properties.		* The [[App_FeaturePython\|App FeaturePython]] class, an empty object that can be used for different purposes, depending on the added properties.
	* The [[App_RPSFeature\|App RPSFeature]] class, the base object of all random phenomenon simulation objects.		* The [[App_RPSFeature\|App RPSFeature]] class, the base object of all random phenomenon simulation objects.
	* The [[WindLab_Feature\|WindLab Feature]] class, derived from App RPSFeature.
	* The [[SeismicLab_Feature\|SeismicLab Feature]] class, derived from App RPSFeature.
	* The [[SeaLab_Feature\|SeaLab Feature]] class, derived from App RPSFeature.

	== Properties ==		== Properties ==
Line 39:		Line 36:
	{{Emphasis\|See also:}} [[LabRPS_Scripting_Basics\|LabRPS Scripting Basics]] and [[Scripted_objects\|scripted objects]].		{{Emphasis\|See also:}} [[LabRPS_Scripting_Basics\|LabRPS Scripting Basics]] and [[Scripted_objects\|scripted objects]].

	~~See [[WindLab_Feature\|WindLab Feature]] for the general information on adding objects to the document.~~		A DocumentObject is created with the {{incode\|addObject()}} method of the document. However, in general, there is no need to create this object manually. It is usually better to subclass one of the more complex classes, for example, [[App_FeaturePython\|App FeaturePython]], etc.

	A DocumentObject is created with the {{incode\|addObject()}} method of the document. However, in general, there is no need to create this object manually. It is usually better to subclass one of the more complex classes, for example, [[App_FeaturePython\|App FeaturePython~~]], [[App_RPSFeature\|App RPSFeature]], [[WindLab_Feature\|WindLab Feature~~]], etc.

	{{Code\|code=		{{Code\|code=

LabRPS: Created page with "{{TOCright}} == Introduction == An App DocumentObject object, or formally an {{incode|App::DocumentObject}}, is the base class of all object classes handled in the document. In general terms, a "DocumentObject" is any "thing" that can appear in the Tree view, and which is saved and restored when opening a document. 800px {{Caption|Simplified diagram of the relationships between the core objects i..."

2024-10-28T15:25:42Z

Created page with "{{TOCright}} == Introduction == An App DocumentObject object, or formally an {{incode|App::DocumentObject}}, is the base class of all object classes handled in the document. In general terms, a "DocumentObject" is any "thing" that can appear in the Tree view, and which is saved and restored when opening a document. 800px {{Caption|Simplified diagram of the relationships between the core objects i..."

New page

{{TOCright}}

== Introduction ==

An [[App_DocumentObject|App DocumentObject]] object, or formally an {{incode|App::DocumentObject}}, is the base class of all object classes handled in the document.

In general terms, a "DocumentObject" is any "thing" that can appear in the [[Tree_view|Tree view]], and which is saved and restored when opening a document.

[[File:LabRPS_core_objects.svg|800px]]

{{Caption|Simplified diagram of the relationships between the core objects in LabRPS}}

== Usage ==

The [[App_DocumentObject|App DocumentObject]] is an internal class, so it cannot be created from the graphical interface, nor is it meant to be used by itself. It just defines the basic behavior and properties of objects in the program.

Some of the most important DocumentObjects are the following:
* The [[App_FeaturePython|App FeaturePython]] class, an empty object that can be used for different purposes, depending on the added properties.
* The [[App_RPSFeature|App RPSFeature]] class, the base object of all random phenomenon simulation objects.
* The [[WindLab_Feature|WindLab Feature]] class, derived from App RPSFeature.
* The [[SeismicLab_Feature|SeismicLab Feature]] class, derived from App RPSFeature.
* The [[SeaLab_Feature|SeaLab Feature]] class, derived from App RPSFeature.

== Properties ==

See [[Property|Property]] for all property types that scripted objects can have.

These are the basic properties that essentially all objects have. These properties can be accessed from the [[Python console|Python console]].

* {{PropertyData|Label|String}}: the user editable name of this object, it is an arbitrary UTF8 string. By default, it is the same as the {{incode|Name}}.
* {{PropertyData|Label2|String}}: a longer, user editable description of this object, it is an arbitrary UTF8 string that may include newlines. By default, it is an empty string {{value|""}}.
* {{PropertyData|Expression Engine|ExpressionEngine}}: a list of expressions.
* {{PropertyData|Visibility|Bool}}: whether to display the object or not.

For derived objects, only {{PropertyData|Label}} will be listed in the [[property editor|property editor]] by default. The other properties will be hidden.

== Scripting ==

{{Emphasis|See also:}} [[LabRPS_Scripting_Basics|LabRPS Scripting Basics]] and [[Scripted_objects|scripted objects]].

See [[WindLab_Feature|WindLab Feature]] for the general information on adding objects to the document.

A DocumentObject is created with the {{incode|addObject()}} method of the document. However, in general, there is no need to create this object manually. It is usually better to subclass one of the more complex classes, for example, [[App_FeaturePython|App FeaturePython]], [[App_RPSFeature|App RPSFeature]], [[WindLab_Feature|WindLab Feature]], etc.

{{Code|code=
import LabRPS as App

doc = App.newDocument()
obj = App.ActiveDocument.addObject("App::DocumentObject", "Name")
obj.Label = "Custom label"
}}

{{Document_objects_navi}}
{{Userdocnavi}}