SoSFBox3d(3)

πŸ“¦ version 2.5.0, in fedora 43, fedora 44

✨ NAME ✨

SoSFBox3d β€” bestie, it's a container for an SbBox3d vector. that's the whole job. that's the assignment. πŸ’…

(this is the SoSFBox3d(3) page from the Library Functions Manual, fyi 🫢)


🌈 SYNOPSIS 🌈

#include <Inventor/fields/SoSFBox3d.h>

Inherits SoSField. πŸ’–

πŸŽ€ Public Member Functions πŸŽ€

  • virtual SoType getTypeId (void) const β€” grab the type id, the lil name tag that says which class this is
  • virtual void copyFrom (const SoField &field) β€” copy the value(s) over from another field
  • const SoSFBox3d & operator= (const SoSFBox3d &field) β€” assignment, but with SoSFBox3d energy
  • virtual SbBool isSame (const SoField &field) const β€” are these two the same type AND same value(s)? asking for a friend
  • const SbBox3d & getValue (void) const β€” hand me the box
  • void setValue (const SbBox3d &newvalue) β€” here's the box, take it
  • const SbBox3d & operator= (const SbBox3d &newvalue) β€” box assignment, slay
  • int operator== (const SoSFBox3d &field) const β€” equal? yes/no
  • int operator!= (const SoSFBox3d &field) const β€” not equal? yes/no
  • void setValue (double xmin, double ymin, double zmin, double xmax, double ymax, double zmax) β€” set the box from six raw numbers, iconic
  • void setValue (const SbVec3d &minvec, const SbVec3d &maxvec) β€” set the box from a min vec and a max vec
  • void getValue (SbBox3d &box) const β€” write the value out into box

πŸ’œ Public Member Functions inherited from SoSField πŸ’œ

  • virtual ~SoSField () β€” destructor, bye bestie

πŸ’œ Public Member Functions inherited from SoField πŸ’œ

  • virtual ~SoField () β€” destructor
  • void setIgnored (SbBool ignore) β€” set the ignored flag
  • SbBool isIgnored (void) const β€” is it ignored tho
  • void setDefault (SbBool def) β€” mark it as default
  • SbBool isDefault (void) const β€” is it default tho
  • SbBool isOfType (const SoType type) const β€” type check
  • void enableConnection (SbBool flag) β€” turn connections on/off
  • SbBool isConnectionEnabled (void) const β€” are connections enabled
  • SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=0, SbBool append=0) β€” connect from an engine output
  • SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=0) β€” append an engine-output connection
  • void disconnect (SoEngineOutput *engineoutput) β€” un-connect that engine output
  • SbBool isConnectedFromEngine (void) const β€” connected from an engine?
  • SbBool getConnectedEngine (SoEngineOutput *&master) const β€” who's the engine master
  • SbBool connectFrom (SoField *master, SbBool notnotify=0, SbBool append=0) β€” connect from another field
  • SbBool appendConnection (SoField *master, SbBool notnotify=0) β€” append a field connection
  • void disconnect (SoField *field) β€” un-connect that field
  • SbBool isConnectedFromField (void) const β€” connected from a field?
  • SbBool getConnectedField (SoField *&master) const β€” who's the field master
  • int getNumConnections (void) const β€” how many connections
  • int getForwardConnections (SoFieldList &slavelist) const β€” forward connections go into slavelist
  • int getConnections (SoFieldList &masterlist) const β€” connections go into masterlist
  • void disconnect (void) β€” nuke all the connections
  • SbBool isConnected (void) const β€” connected at all?
  • void setContainer (SoFieldContainer *cont) β€” set the container
  • SoFieldContainer * getContainer (void) const β€” get the container
  • SbBool set (const char *valuestring) β€” set from a string
  • void get (SbString &valuestring) β€” get as a string
  • SbBool shouldWrite (void) const β€” should this be written out?
  • virtual void touch (void) β€” touch it, make it go brrr
  • virtual void startNotify (void) β€” start notifying
  • virtual void notify (SoNotList *nlist) β€” notify, with a list
  • SbBool enableNotify (SbBool on) β€” notifications on/off
  • SbBool isNotifyEnabled (void) const β€” notifications enabled?
  • void addAuditor (void *f, SoNotRec::Type type) β€” add an auditor
  • void removeAuditor (void *f, SoNotRec::Type type) β€” remove an auditor
  • int operator== (const SoField &f) const β€” equal?
  • int operator!= (const SoField &f) const β€” not equal?
  • virtual void connectionStatusChanged (int numconnections) β€” connection status changed, heads up
  • SbBool isReadOnly (void) const β€” read-only?
  • virtual void fixCopy (SbBool copyconnections) β€” fix up the copy
  • virtual SbBool referencesCopy (void) const β€” does it reference the copy
  • void copyConnection (const SoField *fromfield) β€” copy the connection from another field
  • virtual SbBool read (SoInput *in, const SbName &name) β€” read it in
  • virtual void write (SoOutput *out, const SbName &name) const β€” write it out
  • virtual void countWriteRefs (SoOutput *out) const β€” count the write refs
  • void setFieldType (int type) β€” set the field type
  • int getFieldType (void) const β€” get the field type
  • SbBool getDirty (void) const β€” is it dirty
  • void setDirty (SbBool dirty) β€” set the dirty flag
  • void evaluate (void) const β€” evaluate it

πŸŽ€ Static Public Member Functions πŸŽ€

  • static void * createInstance (void) β€” make an instance
  • static SoType getClassTypeId (void) β€” get the class type id
  • static void initClass (void) β€” init the class

πŸ’œ Static Public Member Functions inherited from SoSField πŸ’œ

  • static void initClass (void) β€” init the class
  • static SoType getClassTypeId (void) β€” get the class type id

πŸ’œ Static Public Member Functions inherited from SoField πŸ’œ

  • static void initClass (void) β€” init the class
  • static void initClasses (void) β€” init ALL the classes (plural, periodt)
  • static SoType getClassTypeId (void) β€” get the class type id

πŸŽ€ Protected Attributes πŸŽ€

  • SbBox3d value β€” the actual box value, living its best protected life

πŸŽ€ 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) β€” constructor

πŸ’œ Protected Member Functions inherited from SoField πŸ’œ

  • SoField (void) β€” constructor
  • void valueChanged (SbBool resetdefault=1) β€” the value changed, alert the group chat
  • virtual void evaluateConnection (void) const β€” evaluate the connection
  • virtual SbBool readConnection (SoInput *in) β€” read the connection
  • virtual void writeConnection (SoOutput *out) const β€” write the connection
  • SbBool isDestructing (void) const β€” mid-destruction? asking

🌸 Detailed Description 🌸

okay so. the SoSFBox3d class is a container for an SbBox3d vector. no cap. 🫢

This field is used where nodes, engines or other field containers needs to store a box. like, that's its whole purpose in life and honestly? iconic. πŸ‘‘

⚠️ heads up bestie: be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. so if you're kicking it old-school with the SGI original, this one is Not For You. πŸ’€

Since β€” Coin 2.5 ✨


πŸ¦‹ Member Function Documentation πŸ¦‹

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

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to. it's like a lil name tag but for classes, and it never lies. πŸŽ€

See also β€” getClassTypeId(), SoType

Implements SoField.


void SoSFBox3d::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 types, that's the rule, i don't make 'em. πŸ™ˆ

Implements SoField.


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

Check for equal type and value(s). both of 'em. the whole package. πŸ’…

Implements SoField.


void SoSFBox3d::setValue (double xmin, double ymin, double zmin, double xmax, double ymax, double zmax)

Set value of vector. six numbers, one box, go off. πŸ”₯


void SoSFBox3d::setValue (const SbVec3d & minvec, const SbVec3d & maxvec)

Set value of vector. min vec, max vec, that's it that's the whole thing. ✨


void SoSFBox3d::getValue (SbBox3d & box) const

Set value of vector. (yes bestie, the original really does say "set" here β€” i'm just the messenger, don't shoot me 😭)


πŸ’œ Author πŸ’œ

Generated automatically by Doxygen for Coin from the source code. so technically the author is a robot. a very productive robot. πŸ€–πŸ’–


and that's a wrap, bestie!! 🫢 this was Coin, Version 2.5.0, serving you the SoSFBox3d(3) page. go forth and store your boxes. slay πŸ’…βœ¨πŸŒˆ

πŸ“¦ where this page comes from