SoAnnoText3Property Class Reference

Annotation text property node. More...

#include <Inventor/nodes/SoAnnoText3Property.h>

Inheritance diagram for SoAnnoText3Property:

Public Types
enum	RenderPrintType {   RENDER3D_PRINT_VECTOR ,   RENDER3D_PRINT_RASTER ,   RENDER2D_PRINT_RASTER }
	Render print type. More...
enum	FontSizeHint {   ANNOTATION ,   FIT_VECTOR_TEXT }
	Font size hint. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoAnnoText3Property ()
	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 SoNode *	copy (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 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	setMaxViewingFontSize (unsigned int size)
	Sets the maximum font size (in pixels) when renderPrintType field is equal to RENDER2D_PRINT_RASTER.
static unsigned int	getMaxViewingFontSize ()
	Gets the maximum font size (in pixels) that can be used when renderPrintType field is equal to RENDER2D_PRINT_RASTER.
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
SoSFEnum	renderPrintType
	This flag specifies how annotation text should be rendered (as 3D text or 2D text) and how it should be printed when the Hard Copy Extension is used (as 3D vectors or 2D PostScript raster fonts).
SoSFBool	isCharOrientedRasterPrint
	This flag is used when the field renderPrintType is equal to RENDER3D_PRINT_RASTER or RENDER2D_PRINT_RASTER.
SoSFEnum	fontSizeHint
	This flag is used when the field renderPrintType is equal to RENDER3D_PRINT_RASTER or RENDER2D_PRINT_RASTER.

Detailed Description

Annotation text property node.

This node sets the current annotation text properties in the state used by all subsequent SoAnnoText3 nodes.

FILE FORMAT/DEFAULT

AnnoText3Property {

renderPrintType	RENDER3D_PRINT_VECTOR
isCharOrientedRasterPrint	TRUE
fontSizeHint	FIT_VECTOR_TEXT

}

ACTION BEHAVIOR

Sets: SoAnnoText3CharOrientElement, SoAnnoText3FontSizeHintElement, SoAnnoText3RenderPrintElement

SEE ALSO

SoAnnoText3

Definition at line 61 of file SoAnnoText3Property.h.

Member Enumeration Documentation

FontSizeHint

enum SoAnnoText3Property::FontSizeHint

Font size hint.

Enumerator
ANNOTATION	2D text maintains its nominal font size from any view angle.
FIT_VECTOR_TEXT	The font size of 2D text changes according to the view angle (it follows the projection on the screen of 3D text).

Definition at line 90 of file SoAnnoText3Property.h.

RenderPrintType

enum SoAnnoText3Property::RenderPrintType

Render print type.

Enumerator
RENDER3D_PRINT_VECTOR	Text is rendered in 3D (like SoText3). It is printed as vectors when the Hard Copy Extension (formerly known as PlotMaster) is used.
RENDER3D_PRINT_RASTER	Text is rendered in 3D (like SoText3). It is printed as raster text using PostScript fonts when the Hard Copy Extension is used.
RENDER2D_PRINT_RASTER	Text is rendered in 2D (like SoText2) but can be zoomed because the font size is interpreted in the current units. It is printed as raster text using PostScript fonts when the Hard Copy Extension is used. Note: if this render type is set, the text will not be exported by an SoToPDFAction.

Definition at line 68 of file SoAnnoText3Property.h.

Constructor & Destructor Documentation

SoAnnoText3Property()

SoAnnoText3Property::SoAnnoText3Property

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType SoAnnoText3Property::getClassTypeId ( )

static

Returns the type identifier for this class.

getMaxViewingFontSize()

static unsigned int SoAnnoText3Property::getMaxViewingFontSize ( )

static

Gets the maximum font size (in pixels) that can be used when renderPrintType field is equal to RENDER2D_PRINT_RASTER.

getTypeId()

virtual SoType SoAnnoText3Property::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

setMaxViewingFontSize()

static void SoAnnoText3Property::setMaxViewingFontSize ( unsigned int  size )

static

Sets the maximum font size (in pixels) when renderPrintType field is equal to RENDER2D_PRINT_RASTER.

The maximum font size can also be set using the OIV_MAX_ANNO_RENDER2D_SIZE environment variable.

Member Data Documentation

fontSizeHint

SoSFEnum SoAnnoText3Property::fontSizeHint

This flag is used when the field renderPrintType is equal to RENDER3D_PRINT_RASTER or RENDER2D_PRINT_RASTER.

It specifies how the font size for 2D text (whether rendered or raster) changes according to the view. Use enum FontSizeHint. Default is FIT_VECTOR_TEXT.

Definition at line 127 of file SoAnnoText3Property.h.

isCharOrientedRasterPrint

SoSFBool SoAnnoText3Property::isCharOrientedRasterPrint

This flag is used when the field renderPrintType is equal to RENDER3D_PRINT_RASTER or RENDER2D_PRINT_RASTER.

It specifies whether the text should be oriented (or not) for printing when using the Hard Copy Extension. Default is TRUE.

Definition at line 120 of file SoAnnoText3Property.h.

renderPrintType

SoSFEnum SoAnnoText3Property::renderPrintType

This flag specifies how annotation text should be rendered (as 3D text or 2D text) and how it should be printed when the Hard Copy Extension is used (as 3D vectors or 2D PostScript raster fonts).

Use enum RenderPrintType. Default is RENDER3D_PRINT_VECTOR.

Definition at line 113 of file SoAnnoText3Property.h.

---

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

• Inventor/nodes/SoAnnoText3Property.h