SoSFPath(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ SoSFPath(3) ✨

okay bestie, buckle up 💖 this is the SoSFPath(3) page, straight outta the Library Functions Manual, and I'm gonna explain it to you the way it deserves to be explained. no cap.

🌸 NAME 🌸

SoSFPath — the SoSFPath class is a container for a single path. that's the whole thing. iconic, honestly.

🦋 SYNOPSIS 🦋

#include <Inventor/fields/SoSFPath.h>

Inherits SoSField.

💅 Public Member Functions 💅

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoSFPath & operator= (const SoSFPath &field)
  • virtual SbBool isSame (const SoField &field) const
  • SoPath * getValue (void) const
  • void setValue (SoPath *newvalue)
  • SoPath * operator= (SoPath *newvalue)
  • int operator== (const SoSFPath &field) const
  • int operator!= (const SoSFPath &field) const
  • virtual void notify (SoNotList *l)
  • virtual void fixCopy (SbBool copyconnections)
  • virtual SbBool referencesCopy (void) const

🫶 Public Member Functions inherited from SoSField 🫶

  • virtual ~SoSField ()

🫶 Public Member Functions inherited from SoField 🫶

  • virtual ~SoField ()
  • void setIgnored (SbBool ignore)
  • SbBool isIgnored (void) const
  • void setDefault (SbBool def)
  • SbBool isDefault (void) const
  • SbBool isOfType (const SoType type) const
  • void enableConnection (SbBool flag)
  • SbBool isConnectionEnabled (void) const
  • SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=0, SbBool append=0)
  • SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=0)
  • void disconnect (SoEngineOutput *engineoutput)
  • SbBool isConnectedFromEngine (void) const
  • SbBool getConnectedEngine (SoEngineOutput *&master) const
  • SbBool connectFrom (SoField *master, SbBool notnotify=0, SbBool append=0)
  • SbBool appendConnection (SoField *master, SbBool notnotify=0)
  • void disconnect (SoField *field)
  • SbBool isConnectedFromField (void) const
  • SbBool getConnectedField (SoField *&master) const
  • int getNumConnections (void) const
  • int getForwardConnections (SoFieldList &slavelist) const
  • int getConnections (SoFieldList &masterlist) const
  • void disconnect (void)
  • SbBool isConnected (void) const
  • void setContainer (SoFieldContainer *cont)
  • SoFieldContainer * getContainer (void) const
  • SbBool set (const char *valuestring)
  • void get (SbString &valuestring)
  • SbBool shouldWrite (void) const
  • virtual void touch (void)
  • virtual void startNotify (void)
  • SbBool enableNotify (SbBool on)
  • SbBool isNotifyEnabled (void) const
  • void addAuditor (void *f, SoNotRec::Type type)
  • void removeAuditor (void *f, SoNotRec::Type type)
  • int operator== (const SoField &f) const
  • int operator!= (const SoField &f) const
  • virtual void connectionStatusChanged (int numconnections)
  • SbBool isReadOnly (void) const
  • void copyConnection (const SoField *fromfield)
  • virtual SbBool read (SoInput *in, const SbName &name)
  • virtual void write (SoOutput *out, const SbName &name) const
  • void setFieldType (int type)
  • int getFieldType (void) const
  • SbBool getDirty (void) const
  • void setDirty (SbBool dirty)
  • void evaluate (void) const

⭐ Static Public Member Functions ⭐

  • static void * createInstance (void)
  • static SoType getClassTypeId (void)
  • static void initClass (void)

⭐ Static Public Member Functions inherited from SoSField ⭐

  • static void initClass (void)
  • static SoType getClassTypeId (void)

⭐ Static Public Member Functions inherited from SoField ⭐

  • static void initClass (void)
  • static void initClasses (void)
  • static SoType getClassTypeId (void)

🔒 Protected Attributes 🔒

  • SoPath * value

👯 Friends 👯

  • class SoMFPath

🌈 Additional Inherited Members 🌈

  • Public Types inherited from SoField:
    • enum FieldType { NORMAL_FIELD = 0, EVENTIN_FIELD, EVENTOUT_FIELD, EXPOSED_FIELD }
  • Protected Member Functions inherited from SoSField:
    • SoSField (void)
  • Protected Member Functions inherited from SoField:
    • SoField (void)
    • void valueChanged (SbBool resetdefault=1)
    • virtual void evaluateConnection (void) const
    • virtual SbBool readConnection (SoInput *in)
    • virtual void writeConnection (SoOutput *out) const
    • SbBool isDestructing (void) const

💖 Detailed Description 💖

The SoSFPath class is a container for a single path. yes, we're saying it again, because it's the whole personality.

This field container stores a pointer to a Coin path. it handles all the necessary functionality for dealing with copy, import and export operations. so like, it's the responsible one in the group chat. 💅

heads up bestie: the path pointer stored in a field instance of this type may be a NULL pointer. fr fr. not a drill.

See also

SoPath, SoMFPath

🧚 Member Function Documentation 🧚

SoType SoSFPath::getTypeId (void ) const [virtual]

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to. it's giving ID card, but for classes. 👑

See also

getClassTypeId(), SoType

Implements SoField.

void SoSFPath::copyFrom (const SoField & f) [virtual]

Copy value(s) from f into this field. f must be of the same type as this field. no mixing, bestie, it's a strict vibe check.

Implements SoField.

SbBool SoSFPath::isSame (const SoField & f) const [virtual]

Check for equal type and value(s). basically "are we the same person?" energy. ✨

Implements SoField.

void SoSFPath::notify (SoNotList * nlist) [virtual]

Notify auditors that this field has changed. the group chat ping of the C++ world. 📣

Reimplemented from SoField.

References SoField::notify().

void SoSFPath::fixCopy (SbBool copyconnections) [virtual]

This method is internally called after SoField::copyFrom() during scene graph copies, and should do the operations necessary for fixing up the field instance after it has gotten a new value.

The default method in the SoField superclass does nothing. lowkey a slacker, but okay.

The application programmer should normally not need to consider this method, unless he constructs a complex field type which contains new references to container instances (i.e. nodes or engines). Overriding this method is then necessary to update the reference pointers, as they could have been duplicated during the copy operation.

Reimplemented from SoField.

References SoBase::assertAlive(), SoPath::copy(), and SoFieldContainer::findCopy().

SbBool SoSFPath::referencesCopy (void ) const [virtual]

Returns TRUE if this field has references to any containers in the scene graph which are also duplicated during the copy operation.

careful, bestie: note that this method only is valid to call during copy operations.

See also the note about the relevance of the fixCopy() method for application programmers, as it is applicable on this method aswell.

Reimplemented from SoField.

References SoFieldContainer::checkCopy(), SoPath::getHead(), SoBase::isOfType(), and SoField::referencesCopy().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. so technically the author is a robot. a very hardworking robot. we stan. 🫶

and that's the page, bestie!! 💜 this was Coin, Version 2.5.0, page SoSFPath(3) — go forth and container your single path. slay. 💅✨

📦 where this page comes from