| PoPolarLogAxis Class |
Class to build a logarithmic polar axis.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodekitsSoBaseKit
OIV.MeshViz.GraphPoBase
OIV.MeshViz.GraphPoGraphMaster
OIV.MeshViz.GraphPoBaseAxis
OIV.MeshViz.GraphPoAxis
OIV.MeshViz.GraphPoPolarAxis
OIV.MeshViz.GraphPoPolarLogAxis
Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe PoPolarLogAxis type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PoPolarLogAxis | Default constructor. |
| PoPolarLogAxis(Single, Single, Single, Single) | Calls PoPolarLogAxis(offset, startRadius, endRadius, theta, OIV.MeshViz.Graph.PoPolarLogAxis.DecadeListDefs( .PoPolarLogAxis.DECADE_LIST_AUTO ), (cli.array<System.UInt16>^)nullptr, System.Int16(0)). |
| PoPolarLogAxis(Single, Single, Single, Single, PoPolarLogAxisDecadeListDefs) | Calls PoPolarLogAxis(offset, startRadius, endRadius, theta, decadeListDef, (cli.array<System.UInt16>^)nullptr, System.Int16(0)). |
| PoPolarLogAxis(Single, Single, Single, Single, PoPolarLogAxisDecadeListDefs, UInt16) | Calls PoPolarLogAxis(offset, startRadius, endRadius, theta, decadeListDef, decadeList, System.Int16(0)). |
| PoPolarLogAxis(Single, Single, Single, Single, PoPolarLogAxisDecadeListDefs, UInt16, Int16) | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoBaseKit.) |
| 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. |
| CreatePathToPart(String, Boolean) | Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr). (Inherited from SoBaseKit.) |
| CreatePathToPart(String, Boolean, SoPath) | Returns a path that begins at this nodekit and ends at partName. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoNode.) |
| DoAction | (Inherited from SoBaseKit.) |
| 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). |
| GetArrow | Gets the arrow axis attributes computed by the last axis rebuilding. |
| GetBoundingBox | (Inherited from SoBaseKit.) |
 | GetClassNodekitCatalog | Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class. |
| GetDomain | Gets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. |
| 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. |
| GetGrad | Gets the graduations axis attributes computed by the last axis rebuilding. |
| GetGrid | Gets the grid axis attributes computed by the last axis rebuilding. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetLogGrad | Returns the current logarithmic graduations attributes (those computed can be different from the associated fields). |
| GetMargin | Gets the margin axis attributes computed by the last axis rebuilding. |
| GetMatrix | (Inherited from SoBaseKit.) |
| GetMiscTextAttr | Gets a reference to OIV.MeshViz.Graph.PbMiscTextAttr object for miscellaneous text attributes. |
| GetMultFactor | Returns the current multiplicative factor attributes (those computed can be different from the associated fields). |
| GetName | Returns the name of an instance. |
| GetNodekitCatalog | Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this instance of OIV.Inventor.Nodekits.SoBaseKit. |
| GetPart | Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. |
| GetPartString | Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part. |
| GetPrimitiveCount | (Inherited from SoBaseKit.) |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetReverseFlag | Gets the reverse flag axis attributes computed by the last axis rebuilding. |
| GetStringName | (Inherited from SoBase.) |
| GetTick | Gets the tick axis attributes computed by the last axis rebuilding. |
| GetTitle | Gets the title axis attributes computed by the last axis rebuilding. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUpdateMethod | Gets update method. |
| GetViewportIsEnabled | (Inherited from SoBaseKit.) |
| GetViewportOrigin | (Inherited from SoBaseKit.) |
| GetViewportSize | (Inherited from SoBaseKit.) |
| GLRender | (Inherited from SoBaseKit.) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoBaseKit.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsBoundingBoxIgnoring | Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal. |
| IsBuilt | Indicates if the node kit has been built at least once. |
| IsModified | Return true, if the kit has been modified, else otherwise. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Inherited from SoNode.) |
| RayPick | (Inherited from SoBaseKit.) |
| Rebuild | Forces the node kit to be rebuilt immediately. |
| Search | (Inherited from SoBaseKit.) |
| Set(String) | This function allows field values of parts (nodes) to be set in several different parts simultaneously. |
| Set(String, String) | This function allows field values of parts (nodes) to be set. |
| SetDomain | Sets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. |
| SetMiscTextAttr | Sets a reference to OIV.MeshViz.Graph.PbMiscTextAttr object for miscellaneous text attributes. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetPart | Inserts the given node (not a copy) as the new part specified by partName. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| SetUpdateMethod | Sets scene graph update method. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| TouchKit | Indicates the node kit is modified. |
| Write | (Inherited from SoBaseKit.) |
Properties| Name | Description | |
|---|---|---|
 | arrowHeight | Arrow height. |
| arrowLength | Arrow length. |
| arrowVisibility | Arrow visibility. |
| boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. |
| decadeFontName | Decade font name. |
| decadeFontSize | Decade graduations font size. |
| decadeList | Specifies if the list of decade graduations is given by the user or is automatically computed. |
| decadeListDef | List of graduations between two power of ten graduations (decade graduations). |
| decadeRep | Defines the representation of the decade graduations between two power of ten graduations. |
| endRadius | Radius at the end of the axis. |
| gradAddString | String to be concatenated. |
| gradAddStringVisibility | Specify the visibility of a string concatenated with the graduations. |
| gradDistAxis | Distance from the graduations to the axis. |
| gradFontName | Graduations font name. |
| gradFontSize | Font size of the graduations. |
| gradPath | Graduations path. |
| gradPosition | Graduations position. |
| gradVisibility | Graduations visibility. |
| gridLengthGradOtherSide | Grid lines length other side graduation texts. |
| gridLengthGradSide | Grid lines length side graduation texts. |
| gridVisibility | Grid lines visibility. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| marginEnd | Margin at the end of the axis. |
| marginStart | Margin at the start of the axis. |
| marginType | Relative or absolute margin. |
| multFactorDistAxis | Distance from the mutiplicative factor to the axis. |
| multFactorPosition | Position of the multiplicative factor. |
| offset | Offset for the axis. |
| reverseFlag | Allow to reverse the writing path of all axis texts. |
| startRadius | Radius at the start of the axis. |
| tenPowerRep | Defines the representation of power of ten graduations. |
| theta | Rotation angle of the axis in radians. |
| tickFirstGrad | First graduation to display. |
| tickLastGrad | Last graduation to display (number starting with the ending one). |
| tickMainLength | Main graduations ticks length. |
| tickNumOrPeriod | Number of secondary graduations (tickSubDef = NUM_SUB_TICK), or period of texts of graduations (tickSubDef = PERIOD_MAIN_TICK). |
| tickPosition | Position of the tick marks. |
| tickSubDef | Secondary graduations tick definition. |
| tickSubLength | Secondary graduations ticks length. |
| tickVisibility | Tick marks visibility. |
| titleDistAxis | Distance from the title to the axis. |
| titleFontName | Title font name. |
| titleFontSize | Font size of the title. |
| titlePath | Path of the title. |
| titlePosition | Position of the title. |
| titleString | Title string. |
| titleVisibility | Visibility of the title. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
Events| Name | Description | |
|---|---|---|
 | PostRebuild | (Inherited from PoBase.) |
| PreRebuild | (Inherited from PoBase.) |
RemarksThis class builds a polar logarithmic axis in the plane XY. This axis will be generated from the point in polar coordinates (startRadius - offset, theta) to the point (endRadius - offset, theta), however the graduations start at startRadius and finish at endRadius. For instance to build a polar logarithmic axis with the first decade graduation being 103 and the last decade graduation being 10E8 (graduation values are: 10E3, 10E4, 10E5, ...,10E8): startRadius = 3 endRadius = 8.
FILE FORMAT/DEFAULT
OIV.MeshViz.Graph.PoPolarLogAxis {
| gradVisibility | VISILITY_DEPEND |
| gradPosition | GRAD_DEPEND |
| gradPath | PATH_DEPEND |
| gradFontName | "" |
| gradFontSize | 0 |
| gradDistAxis | 0 |
| gradAddStringVisibility | false |
| gradAddString | "" |
| marginType | REL_MARGIN |
| marginStart | 0 |
| marginEnd | 0 |
| titleVisibility | VISILITY_DEPEND |
| titlePosition | TITLE_DEPEND |
| titlePath | PATH_DEPEND |
| titleFontName | "" |
| titleFontSize | 0 |
| titleDistAxis | 0 |
| titleString | "" |
| gridVisibility | VISILITY_DEPEND |
| gridLengthGradSide | 0 |
| gridLengthGradOtherSide | 1 |
| arrowVisibility | VISIBILITY_DEPEND |
| arrowHeight | 0.03 |
| arrowLength | 0.05 |
| tickVisibility | VISIBILITY_DEPEND |
| tickPosition | TICK_GRAD_SIDE |
| tickMainLength | 0 |
| tickSubLength | 0 |
| tickSubDef | PERIOD_MAIN_TICK |
| tickNumOrPeriod | 1 |
| tickFirstGrad | 1 |
| tickLastGrad | 1 |
| reverseFlag | AXIS_REVERSE_DEPEND |
| offset | 0 |
| startRadius | 0 |
| endRadius | 1 |
| theta | 0 |
| multFactorPosition | MULT_FACTOR_END |
| multFactorDistAxis | 0 |
| decadeListDef | DECADE_LIST_AUTO |
| decadeList | 2 |
| tenPowerRep | TEN_POWER_POW10 |
| decadeRep | DECADE_NONE |
| decadeFontName | "" |
| decadeFontSize | 0 |
<html> <head> <title></title> </head> <body> <h1></h1> <h4> <A NAME="Heading598">CATALOG PARTS</A></h4> <ul><b>PoPolarLogAxis</b> {</ul> <ul><ul><b>Separator</b> <tt>alternateRep</tt> (from PoBase) {<br /> </ul></ul> <ul><ul><ul><b>AppearanceKit</b> <tt>appearance</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.</i></ul></ul></ul> <ul><ul><ul><b>MatrixTransform</b> <tt>domainTransform</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Corresponds to the domain transformation.</i></ul></ul></ul> <ul><ul><ul><b>MatrixTransform</b> <tt>transform</tt> (from PoAxis)</ul></ul></ul> <ul><ul><ul><i>Corresponds to the axis plane orientation matrix to the start.</i></ul></ul></ul> <ul><ul><ul><b>Separator</b> <tt>bodySep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw the body of the axis.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>bodyApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of the body of the axis.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>body </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw the body of the axis.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>arrowSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw the arrow.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>arrowApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of the arrow.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>arrow </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoFaceSet shape to draw the arrow.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>subGradTickSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw sub-graduation tick.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>subGradTickApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of sub-graduation tick.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>subGradTick </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw sub-graduation tick.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>subGradGridSep</tt> (from PoAxis){</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw sub-graduation grid.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>subGradGridApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of sub-graduation grid.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>subGradGrid </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw sub-graduation grid.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>mainGradTickSep</tt> (from PoAxis){</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw main-graduation tick.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>mainGradTickApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of main-graduation tick.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>mainGradTick </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw main-graduation tick.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>mainGradGridSep</tt> (from PoAxis){</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw main-graduation grid.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>mainGradGridApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of main-graduation grid.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>mainGradGrid </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw main-graduation grid.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>mainGradTextSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw main-graduation text.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>mainGradTextApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of main-graduation text. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>mainGradText </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a list of SoAnnoText3 shapes to draw main-graduation text.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>titleSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw title text.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>titleApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of title text. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>title </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoAnnoText3 shape to draw title.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>multFactorSep</tt> {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw multiplicative factor.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>multFactorApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of multiplicative factor. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>multFactor</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a list of SoAnnoText3 shape to draw multiplicative factor.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>decadeTextSep </tt>{</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw decade text.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>decadeTextApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of multiplicative factor. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>decadeText</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a list of SoAnnoText3 shape to draw decade text.</i></ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul><br /> </ul></ul> </body> </html>
See Also