SoVRMLBackground(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 SoVRMLBackground 💖

okay so, bestie, this is the manual page for SoVRMLBackground(3) from the Coin library, and it's giving "let me set the vibe of your entire panorama" energy. Buckle up, it's a long one, so this is part 1. ✨

🌸 NAME 🌸

SoVRMLBackground — the class you use to specify a viewer panorama. Basically you're painting the sky and the ground around your whole scene. Iconic.

✨ SYNOPSIS ✨

#include <Inventor/VRMLnodes/SoVRMLBackground.h>

It inherits from SoNode, so it's part of the node family tree. 👑

🫶 Public Member Functions

  • virtual SoType getTypeId(void) const
  • SoVRMLBackground(void)
  • virtual void GLRender(SoGLRenderAction *action)

🌈 Public Member Functions inherited from SoNode

  • void setOverride(const SbBool state)
  • SbBool isOverride(void) const
  • void setNodeType(const NodeType type)
  • NodeType getNodeType(void) const
  • virtual SoNode * copy(SbBool copyconnections=FALSE) const
  • virtual SbBool affectsState(void) const
  • virtual void doAction(SoAction *action)
  • virtual void GLRenderBelowPath(SoGLRenderAction *action)
  • virtual void GLRenderInPath(SoGLRenderAction *action)
  • virtual void GLRenderOffPath(SoGLRenderAction *action)
  • virtual void callback(SoCallbackAction *action)
  • virtual void getBoundingBox(SoGetBoundingBoxAction *action)
  • virtual void getMatrix(SoGetMatrixAction *action)
  • virtual void handleEvent(SoHandleEventAction *action)
  • virtual void pick(SoPickAction *action)
  • virtual void rayPick(SoRayPickAction *action)
  • virtual void search(SoSearchAction *action)
  • virtual void write(SoWriteAction *action)
  • virtual void audioRender(SoAudioRenderAction *action)
  • virtual void getPrimitiveCount(SoGetPrimitiveCountAction *action)
  • virtual void grabEventsSetup(void)
  • virtual void grabEventsCleanup(void)
  • virtual void startNotify(void)
  • virtual void notify(SoNotList *l)
  • SbUniqueId getNodeId(void) const
  • virtual SoChildList * getChildren(void) const
  • virtual void writeInstance(SoOutput *out)
  • virtual SoNode * addToCopyDict(void) const
  • virtual void copyContents(const SoFieldContainer *from, SbBool copyconnections)
  • virtual SoFieldContainer * copyThroughConnection(void) const

🌈 Public Member Functions inherited from SoFieldContainer

  • void setToDefaults(void)
  • SbBool hasDefaultValues(void) const
  • SbBool fieldsAreEqual(const SoFieldContainer *container) const
  • void copyFieldValues(const SoFieldContainer *container, SbBool copyconnections=FALSE)
  • SbBool set(const char *const fielddata)
  • void get(SbString &fielddata)
  • virtual int getFields(SoFieldList &l) const
  • virtual int getAllFields(SoFieldList &l) const
  • virtual SoField * getField(const SbName &name) const
  • virtual SoField * getEventIn(const SbName &name) const
  • virtual SoField * getEventOut(const SbName &name) const
  • SbBool getFieldName(const SoField *const field, SbName &name) const
  • SbBool enableNotify(const SbBool flag)
  • SbBool isNotifyEnabled(void) const
  • SbBool set(const char *fielddata, SoInput *input)
  • void get(SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue(SoField *field, void *newval)
  • virtual void addWriteReference(SoOutput *out, SbBool isfromfield=FALSE)
  • SbBool getIsBuiltIn(void) const
  • virtual void getFieldsMemorySize(size_t &managed, size_t &unmanaged) const
  • void setUserData(void *userdata) const
  • void * getUserData(void) const

🌈 Public Member Functions inherited from SoBase

  • void ref(void) const
  • void unref(void) const
  • void unrefNoDelete(void) const
  • int32_t getRefCount(void) const
  • void touch(void)
  • SbBool isOfType(SoType type) const — hands you back TRUE if this object's type is either literally the same type, or inherited from type. yes bestie, bloodline matters here.
  • virtual SbName getName(void) const
  • virtual void setName(const SbName &newname)
  • void addAuditor(void *const auditor, const SoNotRec::Type type)
  • void removeAuditor(void *const auditor, const SoNotRec::Type type)
  • const SoAuditorList & getAuditors(void) const
  • SbBool shouldWrite(void)
  • void assertAlive(void) const

⭐ Static Public Member Functions

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

⭐ Static Public Member Functions inherited from SoNode

  • static uint32_t getCompatibilityTypes(const SoType &nodetype)
  • static SoType getClassTypeId(void)
  • static SoNode * getByName(const SbName &name)
  • static int getByName(const SbName &name, SoNodeList &l)
  • static void initClass(void) — sets up all the initialization for the data that every instance of this class shares, like handing over the necessary info to the Coin type system. it's the "get everyone ready" moment.
  • static void initClasses(void)
  • static SbUniqueId getNextNodeId(void)
  • static int getActionMethodIndex(const SoType type)
  • static void getBoundingBoxS(SoAction *action, SoNode *node)
  • static void GLRenderS(SoAction *action, SoNode *node)
  • static void callbackS(SoAction *action, SoNode *node)
  • static void getMatrixS(SoAction *action, SoNode *node)
  • static void handleEventS(SoAction *action, SoNode *node)
  • static void pickS(SoAction *action, SoNode *node)
  • static void rayPickS(SoAction *action, SoNode *node)
  • static void searchS(SoAction *action, SoNode *node)
  • static void writeS(SoAction *action, SoNode *node)
  • static void audioRenderS(SoAction *action, SoNode *node)
  • static void getPrimitiveCountS(SoAction *action, SoNode *node)

⭐ Static Public Member Functions inherited from SoFieldContainer

  • static void initClass(void) — sets up initialization for data common to all instances of this class, like submitting the necessary information to the Coin type system.
  • static SoType getClassTypeId(void) — this static method returns the SoType object that's associated with objects of this class.
  • static void cleanupClass(void)
  • static void initCopyDict(void)
  • static void addCopy(const SoFieldContainer *orig, const SoFieldContainer *copy)
  • static SoFieldContainer * checkCopy(const SoFieldContainer *orig)
  • static SoFieldContainer * findCopy(const SoFieldContainer *orig, const SbBool copyconnections)
  • static void copyDone(void)

⭐ Static Public Member Functions inherited from SoBase

  • static void initClass(void) — sets up initialization for data common to all instances of this class, like submitting the necessary information to the Coin type system.
  • static SoType getClassTypeId(void) — this static method returns the SoType object associated with objects of this class.
  • static void addName(SoBase *const base, const char *const name)
  • static void removeName(SoBase *const base, const char *const name)
  • static void incrementCurrentWriteCounter(void)
  • static void decrementCurrentWriteCounter(void)
  • static SoBase * getNamedBase(const SbName &name, SoType type)
  • static int getNamedBases(const SbName &name, SoBaseList &baselist, SoType type)
  • static SbBool read(SoInput *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix(const SbString &c)
  • static void setTraceRefs(SbBool trace)
  • static SbBool getTraceRefs(void)
  • static SbBool connectRoute(SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute(SoInput *input)

🎀 Public Attributes 🎀

these are the actual vibes you're setting, no cap:

  • SoMFColor groundColor
  • SoMFFloat groundAngle
  • SoMFColor skyColor
  • SoMFFloat skyAngle
  • SoMFString backUrl
  • SoMFString bottomUrl
  • SoMFString frontUrl
  • SoMFString leftUrl
  • SoMFString rightUrl
  • SoMFString topUrl

🔒 Protected Member Functions

  • virtual const SoFieldData * getFieldData(void) const
  • virtual SbBool readInstance(SoInput *in, unsigned short flags)
  • virtual ~SoVRMLBackground()

🔒 Protected Member Functions inherited from SoNode

  • SoNode(void)
  • virtual ~SoNode()

🔒 Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer(void)
  • virtual ~SoFieldContainer()

🔒 Protected Member Functions inherited from SoBase

  • SoBase(void)
  • virtual ~SoBase()
  • virtual void destroy(void)
  • SbBool hasMultipleWriteRefs(void) const
  • SbBool writeHeader(SoOutput *out, SbBool isgroup, SbBool isengine) const
  • void writeFooter(SoOutput *out) const
  • virtual const char * getFileFormatName(void) const
  • virtual SoNotRec createNotRec(void)

🧚 Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr(void)

🧚 Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr(void)
  • static void setNextActionMethodIndex(int index)
  • static int getNextActionMethodIndex(void)
  • static void incNextActionMethodIndex(void)
  • static void setCompatibilityTypes(const SoType &nodetype, const uint32_t bitmask)

🧚 Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter(void)
  • static void staticDataLock(void)
  • static void staticDataUnlock(void)

💜 Protected Attributes

  • SoSFBool set_bind
  • SoSFBool isBound

💜 Protected Attributes inherited from SoNode

  • SbUniqueId uniqueId

💜 Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

🦋 Additional Inherited Members 🦋

Public Types inherited from SoNode

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002,
    INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010,
    INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080,
    COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 =
    0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

Static Protected Attributes inherited from SoNode

  • static SbUniqueId nextUniqueId = 1
  • static int nextActionMethodIndex = 0
heads up bestie, there's more coming 💅 this was only part 1 of 2, so don't go anywhere.

💖 Detailed Description 💖

okay bestie, so the SoVRMLBackground class is literally the blueprint for specifying a viewer panorama 🌈✨. no cap.

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:

Background {
  eventIn      SFBool   set_bind
  exposedField MFFloat  groundAngle  []         # [0,pi/2]
  exposedField MFColor  groundColor  []         # [0,1]
  exposedField MFString backUrl      []
  exposedField MFString bottomUrl    []
  exposedField MFString frontUrl     []
  exposedField MFString leftUrl      []
  exposedField MFString rightUrl     []
  exposedField MFString topUrl       []
  exposedField MFFloat  skyAngle     []         # [0,pi]
  exposedField MFColor  skyColor     0 0 0      # [0,1]
  eventOut     SFBool   isBound
}

The Background node is used to specify a colour backdrop that simulates ground and sky, as well as a background texture, or panorama, that is placed behind all geometry in the scene and in front of the ground and sky. Background nodes are specified in the local coordinate system and are affected by the accumulated rotation of their ancestors as described below. Background nodes are bindable nodes as described in 4.6.10, Bindable children nodes (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.10). There exists a Background stack, in which the top-most Background on the stack is the currently active Background. To move a Background to the top of the stack, a TRUE value is sent to the set_bind eventIn. Once active, the Background is then bound to the browsers view. A FALSE value sent to set_bind removes the Background from the stack and unbinds it from the browser's view. More detail on the bind stack is described in 4.6.10, Bindable children nodes (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.10).

The backdrop is conceptually a partial sphere (the ground) enclosed inside of a full sphere (the sky) in the local coordinate system with the viewer placed at the centre of the spheres. Both spheres have infinite radius and each is painted with concentric circles of interpolated colour perpendicular to the local Y-axis of the sphere. The Background node is subject to the accumulated rotations of its ancestors' transformations. Scaling and translation transformations are ignored. The sky sphere is always slightly farther away from the viewer than the ground partial sphere causing the ground to appear in front of the sky where they overlap. The skyColor field specifies the colour of the sky at various angles on the sky sphere. The first value of the skyColor field specifies the colour of the sky at 0.0 radians representing the zenith (i.e., straight up from the viewer). The skyAngle field specifies the angles from the zenith in which concentric circles of colour appear. The zenith of the sphere is implicitly defined to be 0.0 radians, the natural horizon is at pi/2 radians, and the nadir (i.e., straight down from the viewer) is at pi radians. skyAngle is restricted to non-decreasing values in the range [0.0, pi]. There shall be one more skyColor value than there are skyAngle values. The first colour value is the colour at the zenith, which is not specified in the skyAngle field. If the last skyAngle is less than pi, then the colour band between the last skyAngle and the nadir is clamped to the last skyColor. The sky colour is linearly interpolated between the specified skyColor values.

The groundColor field specifies the colour of the ground at the various angles on the ground partial sphere. The first value of the groundColor field specifies the colour of the ground at 0.0 radians representing the nadir (i.e., straight down from the user). The groundAngle field specifies the angles from the nadir that the concentric circles of colour appear. The nadir of the sphere is implicitly defined at 0.0 radians. groundAngle is restricted to non-decreasing values in the range [0.0, pi/2]. There shall be one more groundColor value than there are groundAngle values. The first colour value is for the nadir which is not specified in the groundAngle field. If the last groundAngle is less than pi/2, the region between the last groundAngle and the equator is non-existent. The ground colour is linearly interpolated between the specified groundColor values.

The backUrl, bottomUrl, frontUrl, leftUrl, rightUrl, and topUrl fields specify a set of images that define a background panorama between the ground/sky backdrop and the scene's geometry. The panorama consists of six images, each of which is mapped onto a face of an infinitely large cube contained within the backdrop spheres and centred in the local coordinate system. The images are applied individually to each face of the cube. On the front, back, right, and left faces of the cube, when viewed from the origin looking down the negative Z-axis with the Y-axis as the view up direction, each image is mapped onto the corresponding face with the same orientation as if the image were displayed normally in 2D (backUrl to back face, frontUrl to front face, leftUrl to left face, and rightUrl to right face). On the top face of the cube, when viewed from the origin looking along the +Y-axis with the +Z-axis as the view up direction, the topUrl image is mapped onto the face with the same orientation as if the image were displayed normally in 2D. On the bottom face of the box, when viewed from the origin along the negative Y-axis with the negative Z-axis as the view up direction, the bottomUrl image is mapped onto the face with the same orientation as if the image were displayed normally in 2D.

Figure 6.1

Figure 6.1 illustrates the Background node backdrop and background textures. Alpha values in the panorama images (i.e., two or four component images) specify that the panorama is semi-transparent or transparent in regions, allowing the groundColor and skyColor to be visible. See 4.6.11, Texture maps, for a general description of texture maps. Often, the bottomUrl and topUrl images will not be specified, to allow sky and ground to show. The other four images may depict surrounding mountains or other distant scenery. Browsers shall support the JPEG (see 2.[JPEG]) and PNG (see 2.[PNG]) image file formats, and in addition, may support any other image format (e.g., CGM) that can be rendered into a 2D image. Support for the GIF (see E.[GIF]) format is recommended (including transparency). More detail on the url fields can be found in 4.5, VRML and the World Wide Web (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.5).

🎀 Constructor & Destructor Documentation 🎀

SoVRMLBackground::SoVRMLBackground (void )

Constructor. 💖

SoVRMLBackground::~SoVRMLBackground () [protected], [virtual]

Destructor. 💀

🌟 Member Function Documentation 🌟

SoType SoVRMLBackground::getClassTypeId (void ) [static]

  • SoMFFloat SoVRMLBackground::groundAngle — The ground angles where different colors should be used.
  • SoMFColor SoVRMLBackground::groundColor — The color for each groundAngle.
  • SoMFFloat SoVRMLBackground::skyAngle — The sky angles where different colors should be used.
  • SoMFColor SoVRMLBackground::skyColor — The color for each skyAngle.
  • SoMFString SoVRMLBackground::backUrl — URL for the background image.
  • SoMFString SoVRMLBackground::bottomUrl — URL for the bottom image.
  • SoMFString SoVRMLBackground::frontUrl — URL for the front image.
  • SoMFString SoVRMLBackground::leftUrl — URL for the left image.
  • SoMFString SoVRMLBackground::rightUrl — URL for the right image.
  • SoMFString SoVRMLBackground::topUrl — URL for the top image.
  • SoSFBool SoVRMLBackground::set_bind — An eventIn which is triggered when the node is bound.
  • SoSFBool SoVRMLBackground::isBound — An eventOut that is sent after the node has been bound/unbound.

This static method returns the SoType object associated with objects of this class.

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Implements SoBase.

const SoFieldData ** SoVRMLBackground::getFieldDataPtr (void ) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Returns the SoFieldData class which holds information about fields in this node.

const SoFieldData * SoVRMLBackground::getFieldData (void ) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoFieldContainer.

void SoVRMLBackground::initClass (void ) [static]

(no description in the original — just the signature, and honestly? iconic.)

void SoVRMLBackground::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method.

Reimplemented from SoNode.

SbBool SoVRMLBackground::readInstance (SoInput * in, unsigned short flags) [protected], [virtual]

This method is mainly intended for internal use during file import operations.

It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistent representation of an instance of this class type.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went OK or not. The import process should be robust and handle corrupted input streams by returning FALSE.

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

Reimplemented from SoNode.

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

and that's the whole vibe, bestie 💅✨ this page is from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00 — and it's literally SoVRMLBackground(3) 🎀🦋 go forth and panorama 🫶

📦 where this page comes from