Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoAlphaPolicy Class Reference

VSG extension Alpha (transparency) policy node More...

#include <Inventor/nodes/SoAlphaPolicy.h>

+ Inheritance diagram for SoAlphaPolicy:

Public Types

enum  Policy {
  POLICY_AS_IS = 0 ,
  POLICY_OPAQUE = 1 ,
  POLICY_DISCARD = 2
}
 Policy to use. More...
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoAlphaPolicy ()
 Default Constructor.
 
- 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 SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual SbBool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal.
 
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 SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (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 Policy getDefaultPolicy ()
 Get default alpha policy.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (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

SoSFEnum policy
 Policy used Please refer to enum Policy.
 

Detailed Description

VSG extension Alpha (transparency) policy node

This node sets the current alpha (transparency) comparison policy for the renderer. It affects the blending operation to control how (and if) a transparent object should be rendered.

Current available policies include :

  • As is : Use the alpha value of the fragment to control color blending
  • Opaque : If the fragment to render has an alpha value greater than 0.0, the object is rendered as opaque (no transparency). If the alpha value is 0.0 the object is considered fully transparent.
  • Discard : If the fragment alpha value is different from 1.0, the object is considered fully transparent. Otherwise it's rendered opaque.

SEE ALSO

SoBlendElement

Definition at line 27 of file SoAlphaPolicy.h.

Member Enumeration Documentation

◆ Policy

Policy to use.

Enumerator
POLICY_AS_IS 

Use the fragment's alpha value as is.

POLICY_OPAQUE 

All semi-transparent fragment (alpha > 0) are considered as opaque.

POLICY_DISCARD 

All semi-transparent fragment (alpha < 1) are considered as fully transparent.

Definition at line 36 of file SoAlphaPolicy.h.

Constructor & Destructor Documentation

◆ SoAlphaPolicy()

SoAlphaPolicy::SoAlphaPolicy ( )

Default Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoAlphaPolicy::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getDefaultPolicy()

static Policy SoAlphaPolicy::getDefaultPolicy ( )
static

Get default alpha policy.

◆ getTypeId()

virtual SoType SoAlphaPolicy::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Member Data Documentation

◆ policy

SoSFEnum SoAlphaPolicy::policy

Policy used Please refer to enum Policy.

Default value is POLICY_AS_IS

Definition at line 63 of file SoAlphaPolicy.h.


The documentation for this class was generated from the following file: