Expressions/it

Descrizione
È possibile definire le proprietà utilizzando espressioni matematiche. Nella GUI, gli spin box o i campi di input che sono legati alle proprietà contengono un'icona blu. Cliccando sull'icona, oppure digitando il segno di uguale, si porta in primo piano l'editor delle espressioni per quella particolare proprietà.

Una espressione di FreeCAD è un'espressione matematica che segue la notazione per gli operatori matematici standard e le funzioni come descritto in seguito. Inoltre, l'espressione può fare riferimento ad altre proprietà, e anche utilizzare le condizioni. I numeri di un'espressione possono opzionalmente essere collegati ad una unità di misura.

I numeri possono usare una virgola ',' o un punto '.' per separare le cifre intere dai decimali. Quando viene utilizzato il separatore decimale, esso "deve" essere seguito da almeno una cifra. Pertanto, le espressioni 1.+2. e 1,+2, non sono valide, ma 1.0+2.0 e 1,0+2,0 sono validi.

Gli operatori e le funzioni sono unit-aware (consapevoli delle unità), e richiedono combinazioni di unità valide, se sono fornite. Ad esempio, 2mm + 4mm è un'espressione valida, mentre 2mm + 4 non lo è (il motivo di questo è che un'espressione come 1in + 4 molto probabilmente viene interpretata come 1in + 4in da un umano, ma tutte le unità vengono convertite nel sistema SI interno, e il sistema non è in grado di indovinare questo). Queste unità sono attualmente riconosciute.

Si possono usare le costanti predefinite e le funzioni.

Function arguments
Quando una funzione accetta più argomenti, questi possono essere separati da un punto e virgola (';') o da una virgola seguita da uno spazio (", "). In quest'ultimo caso, la virgola viene convertita in un punto e virgola dopo la voce. Quando si utilizza un punto e virgola, non è necessario terminare la riga con uno spazio.

Arguments may include references to cells in a spreadsheet. A cell reference consists of the cell's uppercase row letter followed by its column number, for example. A cell may also be referenced by using the cell's alias instead, for example.

Riferimenti a oggetti
Si può fare riferimento a un oggetto tramite il suo o la sua. Nel caso di una, essa deve essere racchiusa tra i simboli e , come questa:.

È possibile fare riferimento a qualsiasi proprietà numerica di un oggetto. Ad esempio, per fare riferimento all'altezza di un cilindro, è possibile utilizzare o.

Per fare riferimento agli oggetti dell'elenco, la sintassi è o. Se ad esempio si desidera fare riferimento a un vincolo in uno schizzo, si può farlo usando questa sintassi <>.Constraints[16]. Se il riferimento si trova nello stesso schizzo, si può ometterne il nome e utilizzare solo Constraints[16]. Nota: L'indice inizia con 0, quindi il vincolo 17 ha l'indice 16.

Per ulteriori informazioni sul riferimento a oggetti, vedere questa sezione.

Costanti supportate
Sono supportate le seguenti costanti:

Supported operators
Sono supportati i seguenti operatori:

Funzioni matematiche generali
Le funzioni matematiche elencate di seguito sono disponibili.

Le funzioni trigonometriche usano i gradi come unità predefinita. Per le misure in radianti aggiungere rad dopo il primo valore in una espressione. Per esempio cos(45) è la stessa cosa di cos(pi rad / 4). Se un'espressione è senza unità e per compatibilità deve essere convertita in gradi o radianti,, moltiplicare per 1 deg, 1 ° o 1 rad secondo il caso, ad es. (360 - X) * 1deg; (360 - X) * 1°; (0.5 + pi / 2) * 1rad. Sono supportate le seguenti funzioni trigonometriche:

Per esponenziazione e logaritmizzazione sono supportate le seguenti funzioni:

Per arrotondamento, troncamento e resto sono supportate queste funzioni :

Statistica e Funzioni di aggregazione
Le funzioni di aggregazione accettano uno o più argomenti, separati da un punto e virgola ';' o da una virgola  e  uno spazio ', '. Gli argomenti possono includere riferimenti a celle di un foglio di calcolo. I riferimenti alla cella sono costituiti dalla lettera maiuscola seguita dal numero della colonna. Gli argomenti possono includere intervalli di celle usando due riferimenti di cella separati da due punti, ad esempio average(B1:B8).

Individual arguments to aggregate functions may consist of ranges of cells. A range of cells is expressed as two cell references separated by a colon, for example or. The cell references may also use cell aliases, for example.

Sono supportate queste funzioni aggregate :

String identification
Strings are identified in expressions by surrounding them with opening/closing double chevrons (as are labels).

In following example, "TEXT" is recognized as a string :

String concatenation
Strings can be concatenated using the '+' sign.

Following example will be concatenated to "MYTEXT".

String formatting
String formatting is supported using the (old) %-style Python way.

All %-specifiers as defined in Python documentation.

As an example, supposing you have a default 10mm-side cube named 'Box' --default FreeCAD naming--, following expression will expand to "Cube length : 10.0 mm"

A limitation is that only one %-specifier is allowed in string, thus you have to use string concatenation if more than one is needed. With same above situation, expression will expand to "Cube length is 10.0 mm and width is 10.0 mm".

A FreeCAD sample file using string formatting is available in the forum

Create function
The following objects may be created in expressions via the function:
 * Vector
 * Matrix
 * Rotation
 * Placement

The function passes subsequent arguments to the underlying Python constructor when creating the object.

Various mathematical operations such as multiplication, addition, and subtraction are supported via standard mathematical operators (e.g., , ).

Vector
When is passed  as the 1st argument, the next 3 arguments are the X, Y, and Z coordinates for the  respectively.

Example:

Matrix
When is passed  as the 1st argument, the next 16 arguments are the elements for the  in row-major order.

Example:

Rotation
When is passed  as the 1st argument, there are two ways to create a :

1. Specify an axis vector and a rotation angle.

Example:

2. Specify 3 rotations about the X, Y, and Z axes as Euler angles.

Example:

Placement
When is passed  as the 1st argument, there are five ways to create a.

These possible combinations are documented in the below table and are based on the Placement API page.

The following example shows the syntax for creating a from a  (vector) and a :

For readability, you can define vectors and rotations in separate cells, and then reference the cells in your expression.

mscale
Scale a with a given.

minvert
Invert the given, , or.

Tuple & list
You can create Python or  objects via their respective functions.

Espressioni condizionali
Le espressioni condizionali sono nella forma '''condition ? resultTrue : resultFalse'''. La condizione è definita come un'espressione il cui risultato è '0' (falso) o diverso da zero (vero). Notare che racchiudere l'espressione condizionale tra parentesi è attualmente considerato un errore.

Sono definiti i seguenti operatori relazionali:

Unità
Le unità possono essere utilizzate direttamente nelle espressioni. Il parser le collega al valore precedente. Quindi '2mm' o '2 mm' è valido mentre 'mm' non è valido perché non esiste un valore precedente.

Tutti i valori devono avere un'unità. Pertanto, in generale è necessario utilizzare un'unità per i valori nei fogli di calcolo. In alcuni casi funziona anche senza un'unità, ad esempio se nella cella B1 del foglio di calcolo si ha solo il numero 1,5 e si fa riferimento ad esso per l'altezza del pad. Questo funziona perché l'altezza del pad predispone l'unità mm che viene utilizzata quando non viene fornita alcuna unità. Però fallisce se si utilizza per l'altezza del pad, ad es. Sketch1.Constraints.Width - Spreadsheet.B1 perché Sketch1.Constraints.Width ha un'unità e Spreadsheet.B1 no.

Le unità con esponenti possono essere inserite direttamente. Quindi ad es. mm^3 viene riconosciuto come mm³ e m^3 viene riconosciuto come m³.

Se una variabile ha il nome di un'unità di misura, bisogna inserire la variabile in << >> per impedire che venga riconosciuta come unità di misura. Ad esempio, la dimensione 'Sketch.Constraints.A' verrebbe riconosciuta come unità Ampere. Pertanto è necessario scriverla nell'espressione in questo modo 'Sketch.Constraints.<>'.

Il parser delle espressioni riconosce le seguenti unità:

Quantità di sostanza:

Angolo:

Corrente:

Electrical capacitance:

Electrical conductance:

Electrical inductance:

Electrical resistance:

Electric charge:

Electric potential:

Energia / Lavoro:

Forza:

Lunghezza:

Intensità luminosa:

Magnetic field strength:

Magnetic flux:

Magnetic flux density:

Massa:

Potenza:

Pressione:

Temperatura:

Tempo:

Volume:

Special imperial units:

Le seguenti unità comunemente utilizzate non sono ancora supportate:

Invalid characters and names
The expression feature is very powerful but to achieve this power it has some limitations concerning some characters. To overcome this, FreeCAD offers to use labels and reference them instead of the object names. In labels you can use almost all special characters.

In cases where you cannot use a label, such as the name of a sketch's constraints, you must be aware what characters are not allowed.

Labels
For labels there are no invalid characters, however some characters need to be escaped:

For example, the label must be referenced as.

Names
Names of objects like dimensions, sketches, etc. may not have the characters or character sequences listed below, otherwise the name is invalid:

For example, the following name is valid:. While these are invalid names: (\r means "carriage return") or  (mol is a unit).

Since shorter names (especially if they have only one or two characters) can easily result in invalid names, consider using longer names and/or establishing a suitable naming convention.

Cell aliases
For spreadsheet cell aliases only alphanumeric characters and underscores ( to, to ,  to  and ) are allowed.

Riferimento ai dati CAD
In un'espressione è possibile utilizzare i dati del modello stesso. Per fare riferimento a una proprietà usare object.property. Se la proprietà è un composto di campi, è possibile accedere ai singoli campi come object.property.field.

La tabella seguente mostra alcuni esempi:

Variabili globali nell'ambito del documento
Al momento in FreeCAD non esiste il concetto di variabili globali. Invece, utilizzando l'ambiente Spreadsheet, si possono definire delle variabili arbitrarie come celle in un foglio di calcolo, e poi assegnare loro un nome utilizzando la proprietà alias della cella (tasto destro del mouse sulla cella). Dopo si può accedere alla variabile da qualsiasi espressione, come per qualsiasi altra proprietà di un oggetto.

Riferimenti incrociati nel documento
È possibile (con limitazioni) definire una proprietà di un oggetto nel documento corrente (file ".FCstd") utilizzando un'espressione per fare riferimento a una proprietà di un oggetto contenuto in un documento diverso (file ".FCstd"). Ad esempio, una cella in un foglio di calcolo o la lunghezza di un cubo di Part, ecc. in un documento può essere definita da un'espressione che fa riferimento al valore di posizionamento X o ad un'altra proprietà di un oggetto contenuto in un documento diverso.

È possibile utilizzare il nome di un documento per fare riferimento ad esso da altri documenti. Quando si salva un documento per la prima volta, si sceglie un nome per il file; questo di solito è diverso dal default iniziale "Unnamed1" (o il suo equivalente tradotto). Per evitare la perdita dei collegamenti quando il documento master viene rinominato al momento del salvataggio, si consiglia di creare prima il documento master, creare un foglio di calcolo al suo interno e salvarlo. Successivamente è ancora possibile apportare modifiche e salvare il file, ma non si deve rinominarlo.

Una volta creato e salvato (e denominato) il documento master con il foglio di calcolo, è possibile creare dei documenti dipendenti. Supponendo che il documento master sia stato denominato "", il foglio di calcolo sia stato rinominato "" e a una cella sia stato assegnato un nome alias "", si può quindi accedere al valore con:

Notare che il documento master deve sempre essere caricato affinché i valori del master siano disponibili per il documento dipendente.

Purtroppo, il checker integrato a volte afferma che un nome valido non esiste. Continuare comunque a digitare. Quando il riferimento è completato, il pulsante diventa attivo.

Naturalmente, dopo spetta all'utente il compito di caricare i documenti corrispondenti, quando si desidera cambiare qualcosa.

Problemi noti / attività rimanenti

 * I grafici delle dipendenze si basano sul rapporto tra gli oggetti del documento, non sulle proprietà. Questo significa che non è possibile fornire i dati a un oggetto e interrogare lo stesso oggetto per i risultati. Ad esempio, anche se non ci sono dipendenze cicliche quando vengono considerate solo le proprietà, non si può avere un oggetto che ottiene le sue dimensioni da un foglio di calcolo e quindi visualizza il volume di tale oggetto nello stesso foglio di calcolo. Per aggirare il problema, utilizzare più fogli di calcolo, ad esempio uno per sviluppare il modello, e uno per i rapporti.
 * Il parser delle espressioni non gestisce bene le parentesi e non è in grado di analizzare correttamente alcune espressioni. Ad esempio: "= (A1 > A2) ? 1 : 0" restituisce un errore, mentre "= A1 > A2 ? 1 : 0" è accettato. L'espressione "= 5 + ((A1>A2) ? 1 : 0)" non può essere inserita in nessuna forma.
 * Come affermato sopra, sfortunatamente, a volte il controllo integrato afferma che non esiste un nome valido. Continuare comunque a digitare. Dopo aver completato il riferimento completo, il pulsante diventerà attivo.
 * Non è implementato nessun gestore delle espressioni in cui siano elencate tutte le espressioni di un documento, e possano essere create, eliminate, interrogate, ecc.
 * I nomi dei vincoli di Sketcher non devono contenere spazi vuoti quando il valore è calcolato da un'espressione, vedere questa discussione nel forum.
 * I bug aperti per le espressioni si trovano in FreeCAD Bugtracker Expressions category