LabRPS: Created page with "{{TOCright}} == Introduction == 32px An App RPSFeature object, or formally an {{incode|App::RPSFeature}}, is the base class of most objects that will allow the creation of random phenomenon simulation related objects. 800px {{Caption|Simplified diagram of the relationships between the core objects in LabRPS}} == Usage == The App RPSFeature is an internal object, so it can..."

2024-10-28T16:33:10Z

Created page with "{{TOCright}} == Introduction == 32px An App RPSFeature object, or formally an {{incode|App::RPSFeature}}, is the base class of most objects that will allow the creation of random phenomenon simulation related objects. 800px {{Caption|Simplified diagram of the relationships between the core objects in LabRPS}} == Usage == The App RPSFeature is an internal object, so it can..."

New page

{{TOCright}}

== Introduction ==

[[File:Feature.svg|32px]]

An [[App_RPSFeature|App RPSFeature]] object, or formally an {{incode|App::RPSFeature}}, is the base class of most objects that will allow the creation of random phenomenon simulation related objects.

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

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

== Usage ==

The [[App_RPSFeature|App RPSFeature]] is an internal object, so it cannot be created from the graphical interface. It is generally not meant to be used directly, rather it can be sub-classed to get a bare-bones object.

Some of the most important derived objects are the following:
* The [[WindLab_Feature|WindLab Feature]] class, the parent of most objects for the simulation of random wind velocity.
* The [[SeismicLab_Feature|SeismicLab Feature]] class, the parent of most objects made from the simulation of seismic ground motion.
* The [[SeaLab_Feature|SeaLab Feature]] class, the parent of most objects for the simulation of random sea surface.

When creating this object in [[Python|Python]], instead of sub-classing {{incode|App::RPSFeature}}, you should sub-class {{incode|App::SimulationPython}} because the latter includes a default view provider, and {{incode|Proxy}} attributes for the object itself, and its view provider. See [[App_RPSFeature#Scripting|Scripting]].

== Properties App RPSFeature ==

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

The [[App_RPSFeature|App RPSFeature]] ({{incode|App::RPSFeature}} class) is derived from the basic [[App_DocumentObject|App DocumentObject]] ({{incode|App::DocumentObject}} class) and inherits all its properties.

== Properties App SimulationPython ==

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

The [[App_RPSFeature|App SimulationPython]] ({{incode|App::SimulationPython}} class) is derived from the basic [[App_RPSFeature|App RPSFeature]] ({{incode|App::RPSFeature}} class) and inherits all its properties. It also has several additional properties.

These are the properties available in the [[Property_editor|property editor]]. Hidden properties can be shown by using the {{MenuCommand|Show all}} command in the context menu of the [[Property_editor|property editor]].

=== Data ===

{{TitleProperty|Base}}

* {{PropertyData|Proxy|PythonObject|Hidden}}: a custom class associated with this object.
* {{PropertyData|Label|String}}: the user editable name of this object, it is an arbitrary UTF8 string.
* {{PropertyData|Label2|String|Hidden}}: 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|Hidden}}: a list of expressions. By default, it is empty {{value|[]}}.
* {{PropertyData|Visibility|Bool|Hidden}}: whether to display the object or not.

=== View ===

{{TitleProperty|Base}}
* {{PropertyView|Proxy|PythonObject|Hidden}}: a custom [[Viewprovider|viewprovider]] class associated with this object.

{{TitleProperty|Display Options}}
* {{PropertyView|Show In Tree|Bool}}: see the information in [[App_FeaturePython|App FeaturePython]].
* {{PropertyView|Visibility|Bool}}: see the information in [[App_FeaturePython|App FeaturePython]].

{{TitleProperty|Selection}}
* {{PropertyView|On Top When Selected|Enumeration}}: see the information in [[App_FeaturePython|App FeaturePython]].
* {{PropertyView|Selection Style|Enumeration}}: see the information in [[App_FeaturePython|App FeaturePython]].

== Scripting ==

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

A RPSFeature is created with the {{incode|addObject()}} method of the document.

{{Code|code=
import LabRPS as App

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

{{Document_objects_navi}}
{{Userdocnavi}}

App RPSFeature - Revision history