Separator group node with a URL hyperlink. More...
#include <Inventor/nodes/SoWWWAnchor.h>
Public Types | |
enum | Mapping { NONE , POINT } |
Mapping. More... | |
Public Types inherited from SoLocateHighlight | |
enum | Styles { EMISSIVE , EMISSIVE_DIFFUSE } |
Possible values for draw style. More... | |
enum | Modes { AUTO , ON , OFF } |
Possible values for the mode. More... | |
Public Types inherited from SoSeparator | |
enum | CacheEnabled { OFF , ON , AUTO } |
Possible values for caching. More... | |
enum | FastEditing { DISABLE = 0x01 , KEEP_ZBUFFER = 0x02 , CLEAR_ZBUFFER = 0x03 } |
Fast editing policy enumeration values. More... | |
Public Member Functions | |
virtual SoType | getTypeId () const |
Returns the type identifier for this specific instance. | |
SoWWWAnchor () | |
Creates an anchor node with default settings. | |
void | setFullURLName (const SbString &url) |
If the name field contains a relative URL (e.g., "foo.wrl" instead of "http://bogus.com/foo.wrl"), the anchor cannot resolve the URL reference. | |
const SbString & | getFullURLName () |
Returns the full URL set by setFullURLName(), or if not set, returns the contents of the name field. | |
Public Member Functions inherited from SoLocateHighlight | |
SoLocateHighlight () | |
Creates a LocateHighlight node with default settings. | |
Public Member Functions inherited from SoSeparator | |
SoSeparator () | |
Creates a separator node with default settings. | |
SoSeparator (int nChildren) | |
Constructor that takes approximate number of children. | |
Public Member Functions inherited from SoGroup | |
SoGroup () | |
Creates an empty group node. | |
SoGroup (int nChildren) | |
Constructor that takes approximate number of children. | |
virtual void | addChild (SoNode *child) |
Adds a child as last one in group. | |
virtual void | insertChild (SoNode *child, int newChildIndex) |
Adds a child so that it becomes the one with the given index. | |
virtual SoNode * | getChild (int index) const |
Returns pointer the child node with the given index. | |
virtual int | findChild (const SoNode *child) const |
Finds index of given child within group. | |
virtual int | getNumChildren () const |
Returns number of children. | |
virtual void | removeChild (int index) |
Removes child with given index from group. | |
virtual void | removeChild (SoNode *child) |
Removes first instance of given child from group. | |
virtual void | removeAllChildren () |
Removes all children from group. | |
virtual void | replaceChild (int index, SoNode *newChild) |
Replaces child with given index with new child. | |
virtual void | replaceChild (SoNode *oldChild, SoNode *newChild) |
Replaces first instance of given child with new child. | |
Public Member Functions inherited from SoNode | |
virtual void | setOverride (const SbBool state) |
Turns the override flag on or off. | |
virtual SbBool | isOverride () const |
Returns the state of the override flag. | |
virtual SoNode * | copy (SbBool copyConnections=FALSE) const |
Creates and returns an exact copy of the node. | |
virtual void | touch () |
Marks an instance as modified, simulating a change to it. | |
Public Member Functions inherited from SoFieldContainer | |
void | setToDefaults () |
Sets all fields in this object to their default values. | |
SbBool | hasDefaultValues () const |
Returns TRUE if all of the object's fields have their default values. | |
SbBool | fieldsAreEqual (const SoFieldContainer *fc) const |
Returns TRUE if this object's fields are exactly equal to fc's fields. | |
void | copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE) |
Copies the contents of fc's fields into this object's fields. | |
SoNONUNICODE SbBool | set (const char *fieldDataString) |
Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. | |
SbBool | set (const SbString &fieldDataString) |
Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. | |
void | get (SbString &fieldDataString) |
Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. | |
virtual int | getFields (SoFieldList &list) const |
Appends references to all of this object's fields to resultList, and returns the number of fields appended. | |
virtual int | getAllFields (SoFieldList &list) const |
Returns a list of fields, including the eventIn's and eventOut's. | |
virtual SoField * | getField (const SbName &fieldName) const |
Returns a the field of this object whose name is fieldName. | |
virtual SoField * | getEventIn (const SbName &fieldName) const |
Returns a the eventIn with the given name. | |
virtual SoField * | getEventOut (const SbName &fieldName) const |
Returns the eventOut with the given name. | |
SbBool | getFieldName (const SoField *field, SbName &fieldName) const |
Returns the name of the given field in the fieldName argument. | |
SbBool | enableNotify (SbBool flag) |
Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). | |
SbBool | isNotifyEnabled () const |
Notification is the process of telling interested objects that this object has changed. | |
virtual void | setUserData (void *data) |
Sets application data. | |
void * | getUserData (void) const |
Gets user application data. | |
Public Member Functions inherited from SoBase | |
virtual SbName | getName () const |
Returns the name of an instance. | |
virtual void | setName (const SbName &name) |
Sets the name of an instance. | |
void | setSynchronizable (const bool b) |
Sets this to be a ScaleViz synchronizable object. | |
bool | isSynchronizable () const |
Gets the ScaleViz synchronizable state of this object. | |
Public Member Functions inherited from SoRefCounter | |
void | ref () const |
Adds a reference to an instance. | |
void | unref () const |
Removes a reference from an instance. | |
void | unrefNoDelete () const |
unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero. | |
int | getRefCount () const |
Returns current reference count. | |
void | lock () const |
lock this instance. | |
void | unlock () const |
unlock this instance. | |
Public Member Functions inherited from SoTypedObject | |
SbBool | isOfType (const SoType &type) const |
Returns TRUE if this object is of the type specified in type or is derived from that type. | |
template<typename TypedObjectClass > | |
SbBool | isOfType () const |
Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class. | |
Static Public Member Functions | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
static void | setFetchURLCallBack (SoWWWAnchorCB *f, void *userData) |
Application callback invoked when the mouse is clicked on an anchor so that the application can fetch the URL. | |
static void | setHighlightURLCallBack (SoWWWAnchorCB *f, void *userData) |
Application callbacks invoked when the mouse is moved over an anchor so that the app can provide feedback such as changing the cursor, or displaying the anchor description and name. | |
static void | enableEvents (SbBool OnOffFlag) |
Static Public Member Functions inherited from SoLocateHighlight | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
static SoDEPRECATED void | turnOffCurrentHighlight (SoGLRenderAction *action) |
This will de-highlight the currently highlighted node if any. | |
Static Public Member Functions inherited from SoSeparator | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Static Public Member Functions inherited from SoGroup | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Static Public Member Functions inherited from SoNode | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
static SoNode * | getByName (const SbName &name) |
A node's name can be set using SoBase::setName(). | |
static int | getByName (const SbName &name, SoNodeList &list) |
A node's name can be set using SoBase::setName(). | |
Static Public Member Functions inherited from SoFieldContainer | |
static SoType | getClassTypeId () |
Returns the type of this class. | |
Static Public Member Functions inherited from SoBase | |
static SoType | getClassTypeId () |
Returns type identifier for this class. | |
Static Public Member Functions inherited from SoTypedObject | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Public Attributes | |
SoSFFilePathString | name |
URL which the application will be called back to fetch when this node is activated by a left mouse click (e.g., "https://www.openinventor.com/"). | |
SoSFString | description |
A description of the URL which may make more sense to users than the URL itself (e.g., "The VSG Home Page"). | |
SoSFEnum | map |
Specifies what additional information should be added to the end of the URL when passed back to the application for fetching. | |
Public Attributes inherited from SoLocateHighlight | |
SoSFColor | color |
Highlighting color - default [.3, .3, .3]. | |
SoSFEnum | style |
Highlighting draw style. | |
SoSFEnum | mode |
Whether to highlight or not. | |
Public Attributes inherited from SoSeparator | |
SoSFEnum | boundingBoxCaching |
Whether to cache during bounding box traversal. | |
SoSFEnum | renderCulling |
Whether to cull during rendering traversal. | |
SoSFEnum | pickCulling |
Whether to cull during picking traversal. | |
SoSFEnum | fastEditing |
Specifies the fast edit mode of the separator node. | |
SoSFInt32 | renderUnitId |
Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator. | |
SoDEPRECATED SoSFEnum | renderCaching |
Whether to cache during rendering traversal. | |
Public Attributes inherited from SoGroup | |
SoSFBool | boundingBoxIgnoring |
Whether to ignore this node during bounding box traversal. | |
Separator group node with a URL hyperlink.
This node defines a separator group which has a URL (Universal Resource Locator) hyperlink. When clicked on, this node invokes an application callback to fetch the URL. The application may fetch the data itself, or call a web browser to load the URL.
boundingBoxCaching | AUTO |
renderCulling | AUTO |
pickCulling | AUTO |
fastEditing | DISABLE |
mode | AUTO |
style | EMISSIVE |
color | 0.3 0.3 0.3 |
name | "<Undefined URL>" |
description | "" |
map | NONE |
Definition at line 113 of file SoWWWAnchor.h.
enum SoWWWAnchor::Mapping |
Mapping.
Enumerator | |
---|---|
NONE | Do no add information to the URL |
POINT | Add object-space coordinates to URL. |
Definition at line 124 of file SoWWWAnchor.h.
SoWWWAnchor::SoWWWAnchor | ( | ) |
Creates an anchor node with default settings.
|
static |
|
static |
Returns the type identifier for this class.
const SbString & SoWWWAnchor::getFullURLName | ( | ) |
Returns the full URL set by setFullURLName(), or if not set, returns the contents of the name field.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from SoLocateHighlight.
|
static |
Application callback invoked when the mouse is clicked on an anchor so that the application can fetch the URL.
|
inline |
If the name field contains a relative URL (e.g., "foo.wrl" instead of "http://bogus.com/foo.wrl"), the anchor cannot resolve the URL reference.
This method allows the application to tell the anchor what its full URL should be. getFullURLName() returns the fullURL set here, or if not set, returns the contents of the name field.
Definition at line 162 of file SoWWWAnchor.h.
|
static |
Application callbacks invoked when the mouse is moved over an anchor so that the app can provide feedback such as changing the cursor, or displaying the anchor description and name.
SoSFString SoWWWAnchor::description |
A description of the URL which may make more sense to users than the URL itself (e.g., "The VSG Home Page").
Definition at line 142 of file SoWWWAnchor.h.
SoSFEnum SoWWWAnchor::map |
Specifies what additional information should be added to the end of the URL when passed back to the application for fetching.
If set to POINT, then the x,y,z location of the object space intersection point when the mouse was clicked will be suffixed to the URL. Since the comma character does not transmit through some web browsers, it is written in hex form (e.g., if the intersection point is 17,4.5,1 the URL passed to the application callback would be "https://www.openinventor.com/?17\%2c4.5\%2c1"). Use enum Mapping. Default is NONE.
Definition at line 153 of file SoWWWAnchor.h.
SoSFFilePathString SoWWWAnchor::name |
URL which the application will be called back to fetch when this node is activated by a left mouse click (e.g., "https://www.openinventor.com/").
Definition at line 136 of file SoWWWAnchor.h.