SoSFPlane(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 NAME 💖

Okay so welcome to the SoSFPlane(3) page, straight out of the Library Functions Manual — and bestie, the tea is simple: the SoSFPlane class is a container for an SbPlane value. That's the whole vibe. A little box. For a plane. 💅

✨ SYNOPSIS ✨

#include <Inventor/fields/SoSFPlane.h>

Inherits SoSField.

Public Member Functions

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoSFPlane & operator= (const SoSFPlane &field)
  • virtual SbBool isSame (const SoField &field) const
  • const SbPlane & getValue (void) const
  • void setValue (const SbPlane &newvalue)
  • const SbPlane & operator= (const SbPlane &newvalue)
  • int operator== (const SoSFPlane &field) const
  • int operator!= (const SoSFPlane &field) 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)
  • virtual void notify (SoNotList *nlist)
  • 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
  • virtual void fixCopy (SbBool copyconnections)
  • virtual SbBool referencesCopy (void) const
  • void copyConnection (const SoField *fromfield)
  • virtual SbBool read (SoInput *in, const SbName &name)
  • virtual void write (SoOutput *out, const SbName &name) const
  • virtual void countWriteRefs (SoOutput *out) 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

  • SbPlane value

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 🌸

So like, the SoSFPlane class is a container for an SbPlane value. Same energy as the NAME section, but now with lore. 🦋

This field is used where nodes, engines or other field containers needs to store a single definition of a 3D plane. One plane. Single. Not a whole collection. It's giving main character energy, except the main character is a geometric plane. 😭

Fields of this type stores their value to file as a normalvector plus an offset from origo: "v0 v1 v2 offset". Yes bestie, that's literally how it writes itself out — no cap. 🫶

See also

SoMFPlane — the multi version, if one plane just isn't enough for you. 👑

💅 Member Function Documentation 💅

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

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to. It's like a little name tag but make it ✨type system✨.

See also

getClassTypeId(), SoType

Implements SoField.

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

Copy value(s) from f into this field. And listen — f must be of the same type as this field. No mixing, no matching, that's the rule fr fr. 🙈

Implements SoField.

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

Check for equal type and value(s). That's it. That's the whole function. Vibe check passed or failed, binary. ⭐

Implements SoField.

🎀 Author 🎀

Generated automatically by Doxygen for Coin from the source code. Not a human, not a bestie, just a robot doing its thing. 🤖

Aww okay that's the whole page!! 💖 Thanks for reading bestie, hope your planes are always well-defined and your offsets are exactly where you left them. 🦋

Coin — Version 2.5.0 — SoSFPlane(3) 💅✨🌸👑

📦 where this page comes from