Annotation

Object Hierarchy

Inheritance

SIObject

ProjectItem

SceneItem

X3DObject

Annotation

Introduced

v10.5 (2012)

Description

The Annotation object is a specialized X3DObject used for inserting text annotation in a scene.

Methods

Add2DChain Add3DChain AddAnnotation AddCamera
AddCameraRig AddChild AddControl AddCustomOp
AddCustomProperty AddFxTree AddGeometry AddICEAttribute
AddLattice AddLight AddLightRig AddMaterial
AddModel AddNull AddNurbsCurve AddNurbsCurveList
AddNurbsCurveList2 AddNurbsSurface AddNurbsSurfaceMesh AddNurbsSurfaceMesh2
AddPolygonMesh AddPrimitive AddProperty AddScriptedOp
AddScriptedOpFromFile AnimatedParameters2 ApplyEnvelope BelongsTo operator
EvaluateAt FindChild FindChild2 FindChildren
FindChildren2 GetActivePrimitive2 GetActivePrimitive3 GetBoundingBox
GetICEAttributeFromName GetLocalPropertyFromName GetLocalPropertyFromName2 GetModels2
GetPropertyFromName GetPropertyFromName2 GetStaticKinematicState operator GetURLAt
HasStaticKinematicState operator IsA IsAnimated2 IsClassOf operator
IsEqualTo operator IsKindOf IsLocked operator IsNodeAnimated
IsSelected operator LockOwners NodeAnimatedParameters RemoveChild
RemoveFromParent RemoveICEAttribute SetAsSelected operator SetCapabilityFlag operator
SetLock SetMaterial ShapeAnimatedClusters TaggedParameters
UnSetLock      
       

Properties

ActivePrimitive Application BranchFlag operator Capabilities operator
Categories Children Envelopes EvaluationID
Families operator FullName operator Help HierarchicalEvaluationID
ICEAttributes Kinematics LocalProperties LocalRotation
LocalScaling LocalTranslation LockLevel operator LockMasters operator
LockType operator Material Materials Model
Models Name operator NestedObjects ObjectID
Origin OriginPath Owners PPGLayout operator
Parameters operator Parent Parent3DObject Primitives
Properties Selected operator Type operator  
       

Examples

Python Example

#
# How to add a simple text annotation to a model object.
#
from siutils import *
mymodel = si().ActiveSceneRoot.AddModel('MyModel')
annotation = mymodel.AddAnnotation('This model is annotated')
log( '%s is annotated with %s: "%s"' % (mymodel.Name, annotation.Name, annotation.Parameters('Message').Value), C.siComment )

See Also

X3DObject.AddAnnotation