MLABMLBaseField Class Reference

#include <mlabMLBaseField.h>

Inherits MLABField.

Public Slots
Scripting access.
QString	persistentString ()
void	setPersistentString (const QString &string)
QString	getMLBaseType ()
bool	isMLBaseDerivedFrom (const QString &parent)
QStringList	getMLBaseAncestors ()
bool	isNull () const
QVariant	object ()
void	setObject (MLRefCountedBaseWrapper *value)
void	setObject (PyObject *object)
void	updateObject (MLRefCountedBaseWrapper *value)
void	updateObject (PyObject *object)
Type checking.
Returns a list of allowed types as strings.
bool	matchesTypes (MLABMLBaseField *field)
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)
MLABFieldOwner *	owner ()
MLABField *	connectedField ()
MLABField *	inputField ()
bool	isConnected ()
bool	isConnectedToFieldInSameNetwork ()
int	outputCount ()
MLABField *	outputField (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
void	touch () override

Detailed Description

A field containing a ML Base object pointer.

Member Function Documentation

getMLBaseAncestors

QStringList MLABMLBaseField::getMLBaseAncestors ( )

slot

Returns a list of ancestors of the current base object, starting with the parent of the object.

getMLBaseType

QString MLABMLBaseField::getMLBaseType ( )

slot

Returns the type of the internal ML Base object, returns an empty string if there is no object set.

isMLBaseDerivedFrom

bool MLABMLBaseField::isMLBaseDerivedFrom ( const QString & parent )

slot

Returns whether the current ML Base object is derived from the given parent.

isNull

bool MLABMLBaseField::isNull ( ) const

slot

Return true if no Base object is set on this field.

matchesTypes

bool MLABMLBaseField::matchesTypes ( MLABMLBaseField * field )

slot

Returns whether the allowed types of this field matches (intersects) the types of the given field.

object

QVariant MLABMLBaseField::object ( )

slot

Returns access to a scriptable base object (NOTE: this is only available if there is a CPPWrapperObject registered for the type of the contained ML Base object).

persistentString

QString MLABMLBaseField::persistentString ( )

slot

Returns the persistent string of the ML Base object.

setObject [1/2]

void MLABMLBaseField::setObject ( MLRefCountedBaseWrapper * value )

slot

Sets the pointer to the ML Base object (from a wrapped object).

setObject [2/2]

void MLABMLBaseField::setObject ( PyObject * object )

slot

Sets the pointer to the Python object.

setPersistentString

void MLABMLBaseField::setPersistentString ( const QString & string )

slot

Sets the persistent string of the ML Base object and touches it.

setStringValue()

void MLABMLBaseField::setStringValue ( const QString & )

inlineoverridevirtual

Sets the value of the field as a string value.

Reimplemented from MLABField.

stringValue()

QString MLABMLBaseField::stringValue ( )

inlineoverridevirtual

Returns the value of the field as a string value.

Reimplemented from MLABField.

stringValueForProfiling()

QString MLABMLBaseField::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 do not want the profiling to cause side effects, e.g., changing the state of an ML image.

Reimplemented from MLABField.

touch()

void MLABMLBaseField::touch ( )

overridevirtual

Forces a notify to all observers without changing the value of the field.

Reimplemented from MLABField.

updateObject [1/2]

void MLABMLBaseField::updateObject ( MLRefCountedBaseWrapper * value )

slot

Sets the pointer to the M LBase object (from a wrapped object) if different from current object.

updateObject [2/2]

void MLABMLBaseField::updateObject ( PyObject * object )

slot

Sets the pointer to the Python object if different from current object.

valueChanged

void MLABMLBaseField::valueChanged ( )

signal

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