Go to Google Code Home
Google SketchUp SkpReader C++ API Documentation (Labs)

Properties

ISkpDrawingElement Interface Reference

The interface supported by object that can be drawn. More...

Inheritance diagram for ISkpDrawingElement:
SkpArcCurve SkpComponentDefinition SkpComponentInstance SkpConstructionLine SkpConstructionPoint SkpDimensionLinear SkpDimensionRadial SkpEdge SkpEdgeUse SkpFace SkpGroup SkpImage

List of all members.

Properties

BOOL IsVisible [get]
 [propget] Determines whether or not the object's visibility flag is true or false.
BOOL IsHighlighted [get]
 [propget] Determines whether or not the object is highlighted in the model.
BOOL HasMaterial [get]
 [propget] Determines whether or not the object has a material directly attached to it.
ISkpMaterial Material [get]
 [propget] Returns the associated material.
ISkpLayer Layer [get]
 [propget] Returns the layer upon which this object resides.
ISkpBoundingBox3d BoundingBox [get]
 Determines the bounding box for this element.
BOOL CastsShadows [get]
 [propget] Returns whether or not this object casts shadows.
BOOL ReceivesShadows [get]
 [propget] Returns whether or not this object receives shadows.

Detailed Description

The interface supported by object that can be drawn.


Property Documentation

ISkpBoundingBox3d ISkpDrawingElement::BoundingBox [get]

Determines the bounding box for this element.

Parameters:
ppBBox The bounding box of this element.
Returns:
S_OK : if successful
E_POINTER : if ppBBox is NULL
E_FAIL : on internal errors.
BOOL ISkpDrawingElement::CastsShadows [get]

[propget] Returns whether or not this object casts shadows.

Return values:
pVal Is TRUE iff the object casts shadows.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
BOOL ISkpDrawingElement::HasMaterial [get]

[propget] Determines whether or not the object has a material directly attached to it.

Return values:
pVal TRUE iff the object has a material.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
BOOL ISkpDrawingElement::IsHighlighted [get]

[propget] Determines whether or not the object is highlighted in the model.

Return values:
pVal TRUE iff the object is highlighted.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
BOOL ISkpDrawingElement::IsVisible [get]

[propget] Determines whether or not the object's visibility flag is true or false.

It should be observed that whether or not an object is ultimately visible in the model is a function not only of this flag, but also of several other variables. These other variables include:

  • The layer it's on;
  • The component it lives in (and this is a recursive relationship);
  • The page that is being rendered;
Return values:
pVal TRUE iff the object's visibility is on.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
ISkpLayer ISkpDrawingElement::Layer [get]

[propget] Returns the layer upon which this object resides.

Every object in the model lives on exactly one layer.

Return values:
pVal The object's layer.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
ISkpMaterial ISkpDrawingElement::Material [get]

[propget] Returns the associated material.

An object may or may not have a material associated with it. Additionally, the way an entity is rendered is only partly determined by the object's material. If the system is set to color-by-layer, then the object's color/material is overridden in the rendering of the object to use the layer's color. Additionally, if the object does not have a material with it, it "inherits" its rendered material via its parent component (recursing on up the parent component hierarchy if necessary) or from the model's default color.

Return values:
pVal The material associated with the object.
Returns:
S_OK : if successful
S_FALSE : if the object does not have a material assocaited with it
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
BOOL ISkpDrawingElement::ReceivesShadows [get]

[propget] Returns whether or not this object receives shadows.

Return values:
pVal Is TRUE iff the object receives shadows.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.

©2010 Google - Google Home - About Google