man SoSFTrigger () - field used to trigger engines or connection networks

NAME

SoSFTrigger - field used to trigger engines or connection networks

INHERITS FROM

SoField > SoSField > SoSFTrigger

SYNOPSIS

#include <Inventor/fields/SoSFTrigger.h> Methods from class SoSFTrigger: c } c } setValue()

c } c } getValue()

c } c } operator ==(const SoSFTrigger &t) const

c } c } operator !=(const SoSFTrigger &t) const Methods from class SoSField: c } c } getClassTypeId() Methods from class SoField: c } c } setIgnored(SbBool ignore)

c } c } isIgnored() const

c } c } isDefault() const

c } c } getTypeId() const

c } c } isOfType(SoType type) const

c } c } set(const char *valueString)

c } c } get(SbString &valueString)

c } c } touch()

c } c } connectFrom(SoField *fromField)

c } c } connectFrom(SoEngineOutput *fromEngine)

c } c } disconnect()

c } c } isConnected() const

c } c } isConnectedFromField() const

c } c } getConnectedField(SoField *&writingField) const

c } c } isConnectedFromEngine() const

c } c } getConnectedEngine(SoEngineOutput *&engineOutput) const

c } c } enableConnection(SbBool flag)

c } c } isConnectionEnabled() const

c } c } getForwardConnections(SoFieldList &list) const

c } c } getContainer() const

DESCRIPTION

This class can be used to start or to synchronize a network of field connections. It is the "null" field - a field with no values. It is typically used as the "start button" for engines that change over time. Triggers can be connected from any other type of field, and will notify any engines or nodes they are part of (or any other triggers they are connected to) whenever the value of the field is set (even if it is set to its current value) or the field is touch()'ed. Since they have no value, SoSFTriggers are not written to file. A node or engine containing an SoSFTrigger field will write only the field's name.

METHODS

c } c } setValue()

Starts the notification process; this is equivalent to calling touch(). c } c } getValue()

Forces any connected engines or fields to evaluate themselves. c } c } operator ==(const SoSFTrigger &t) const

c } c } operator !=(const SoSFTrigger &t) const

All trigger fields are equal; these methods always return TRUE and FALSE, respectively.

SEE ALSO

SoSFBool, SoMFBool