MeVisLab Scripting Reference
MLABSoPathField Class Reference

#include <mlabSoPathField.h>

Inherits MLABField.

Public Slots

Scripting access.


SoPath * object () const
 
void setObject (SoPath *object)
 
bool isNull () const
 
- Public Slots inherited from MLABField
bool isInventorField ()
 
bool isMLField ()
 
QString getType () const
 
QString getName () const
 
virtual QString persistentStringValue ()
 
virtual void setPersistentStringValue (const QString &value)
 
QString truncatedStringValue (int maxChars=80)
 
virtual void touch ()
 
MLABFieldOwnerowner ()
 
MLABFieldconnectedField ()
 
MLABFieldinputField ()
 
bool isConnected ()
 
bool isConnectedToFieldInSameNetwork ()
 
int outputCount ()
 
MLABFieldoutputField (int index)
 
QList< MLABField * > outputFields ()
 
bool connectFrom (MLABField *field)
 
void disconnect ()
 
void disconnectOutputs ()
 
void disconnectAll ()
 
bool connectFromUndoable (MLABField *field)
 
virtual bool isConnectionPossible (MLABField *field)
 
bool isConnectionInSameNetworkPossible (MLABField *field)
 
bool isInSameNetwork (MLABField *field)
 
virtual QString toolTipInfo ()
 
void setPriority (int aPriority)
 
int priority ()
 
void setProxy (bool flag)
 
bool isProxy ()
 
void setComment (const QString &comment)
 
QString comment ()
 
void setTitle (const QString &title)
 
QString title ()
 
QString fullName () const
 
bool isHidden ()
 
void setHidden (bool flag)
 
bool isIgnored ()
 
void setIgnored (bool flag)
 
bool isFilePath ()
 
void setIsFilePath (bool flag)
 
bool isInterfaceField ()
 
bool isParameterField ()
 
bool isInput ()
 
bool isOutput ()
 
bool isInOut ()
 
QString infoString ()
 
bool isPersistent () const
 
bool isEditable () const
 
bool triggersLoading () const
 
void setTriggersLoading (bool flag)
 

Signals

void valueChanged ()
 

Public Member Functions

void setStringValue (const QString &) override
 
QString stringValue () override
 
QString stringValueForProfiling () override
 

Detailed Description

A field containing a SoPath pointer value.

Member Function Documentation

◆ isNull

bool MLABSoPathField::isNull ( ) const
slot

Return true if no SoPath is set on this field.

◆ object

SoPath * MLABSoPathField::object ( ) const
inlineslot

Returns the pointer to the SoPath object.

◆ setObject

void MLABSoPathField::setObject ( SoPath * object)
inlineslot

Sets the pointer to the SoPath object.

◆ setStringValue()

void MLABSoPathField::setStringValue ( const QString & )
inlineoverridevirtual

Sets the value of the field as a string value.

Reimplemented from MLABField.

◆ stringValue()

QString MLABSoPathField::stringValue ( )
inlineoverridevirtual

Returns the value of the field as a string value.

Reimplemented from MLABField.

◆ stringValueForProfiling()

QString MLABSoPathField::stringValueForProfiling ( )
overridevirtual

Returns the string value used for profiling, default returns the string value.

NOTE: be careful on how you re-implement this method in subclasses, since we don't want the profiling to cause side effects, e.g. changing the state of an ML image.

Reimplemented from MLABField.

◆ valueChanged

void MLABSoPathField::valueChanged ( )
signal

Signal that is emitted when the field's value changes.