| SoFontStyle Class |
Defines font family and style for text.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoFont
OIV.Inventor.NodesSoFontStyle
Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.0.0 (2024.2.0)
SyntaxThe SoFontStyle type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoFontStyle | Creates a font style node with default settings. |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Overrides SoFontCallback(SoCallbackAction).) |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoNode.) |
| DoAction | (Overrides SoFontDoAction(SoAction).) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | (Overrides SoFontGetBoundingBox(SoGetBoundingBoxAction).) |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetFontName | Returns the font name used by this node based on the settings of family and style. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Inherited from SoNode.) |
| GetName | Returns the name of an instance. |
| GetPrimitiveCount | (Overrides SoFontGetPrimitiveCount(SoGetPrimitiveCountAction).) |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | (Overrides SoFontGLRender(SoGLRenderAction).) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoNode.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsBoundingBoxIgnoring | This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override field. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Overrides SoFontPick(SoPickAction).) |
| RayPick | (Inherited from SoNode.) |
| Search | (Inherited from SoNode.) |
| Set | 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. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Set the state of the override field. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Inherited from SoNode.) |
Properties| Name | Description | |
|---|---|---|
 | family | Specifies the family of font to use (which determines the font name according to table above). |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| name | This field specifies the font name. |
| renderStyle | This field specifies the rendering style of the font. |
| size | This field specifies the font size. |
| style | Specifies style of the chosen font. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThis node defines the current font family and style for all subsequent text shapes in the scene graph.
Note: The "name" field inherited from OIV.Inventor.Nodes.SoFont is ignored by OIV.Inventor.Nodes.SoFontStyle. This node maps font family and style to a specific predefined font, according to the OS in use. Use the OIV.Inventor.Nodes.SoFontStyle.GetFontName() method to get the actual font name that will be used.
On Windows, the font families are mapped as follows:
| SERIF | Times New Roman |
| SANS | Arial |
| TYPEWRITER | Courier New |
FILE FORMAT/DEFAULT
FontStyle {
| name | "defaultFont" |
| size | 10 |
| family | SERIF |
| style | NONE |
| renderStyle | POLYGON |
ACTION BEHAVIOR
OIV.Inventor.Actions.SoGLRenderAction, OIV.Inventor.Actions.SoCallbackAction, OIV.Inventor.Actions.SoGetBoundingBoxAction, OIV.Inventor.Actions.SoRayPickAction Sets the font family and style in the current traversal state. Sets: OIV.Inventor.Elements.SoFontNameElement, OIV.Inventor.Elements.SoFontSizeElement,
See Also