UsdGeomGprim Class Reference

#include <gprim.h>

Inheritance diagram for UsdGeomGprim:

Public Member Functions
	UsdGeomGprim (const UsdPrim &prim=UsdPrim())
	UsdGeomGprim (const UsdSchemaBase &schemaObj)
virtual USDGEOM_API	~UsdGeomGprim ()
	Destructor. More...
USDGEOM_API UsdAttribute	GetDisplayColorAttr () const
USDGEOM_API UsdAttribute	CreateDisplayColorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute	GetDisplayOpacityAttr () const
USDGEOM_API UsdAttribute	CreateDisplayOpacityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute	GetDoubleSidedAttr () const
USDGEOM_API UsdAttribute	CreateDoubleSidedAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute	GetOrientationAttr () const
USDGEOM_API UsdAttribute	CreateOrientationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdGeomPrimvar	GetDisplayColorPrimvar () const
USDGEOM_API UsdGeomPrimvar	CreateDisplayColorPrimvar (const TfToken &interpolation=TfToken(), int elementSize=-1) const
USDGEOM_API UsdGeomPrimvar	GetDisplayOpacityPrimvar () const
USDGEOM_API UsdGeomPrimvar	CreateDisplayOpacityPrimvar (const TfToken &interpolation=TfToken(), int elementSize=-1) const
Public Member Functions inherited from UsdGeomBoundable
	UsdGeomBoundable (const UsdPrim &prim=UsdPrim())
	UsdGeomBoundable (const UsdSchemaBase &schemaObj)
virtual USDGEOM_API	~UsdGeomBoundable ()
	Destructor. More...
USDGEOM_API UsdAttribute	GetExtentAttr () const
USDGEOM_API UsdAttribute	CreateExtentAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API bool	ComputeExtent (const UsdTimeCode &time, VtVec3fArray *extent)
Public Member Functions inherited from UsdGeomXformable
	UsdGeomXformable (const UsdPrim &prim=UsdPrim())
	UsdGeomXformable (const UsdSchemaBase &schemaObj)
virtual USDGEOM_API	~UsdGeomXformable ()
	Destructor. More...
USDGEOM_API UsdAttribute	GetXformOpOrderAttr () const
USDGEOM_API UsdAttribute	CreateXformOpOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdGeomXformOp	AddXformOp (UsdGeomXformOp::Type const opType, UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddTranslateOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddScaleOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateXYZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateXZYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateYXZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateYZXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateZXYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddRotateZYXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddOrientOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API UsdGeomXformOp	AddTransformOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
USDGEOM_API bool	SetResetXformStack (bool resetXform) const
USDGEOM_API bool	GetResetXformStack () const
USDGEOM_API bool	SetXformOpOrder (std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const
USDGEOM_API std::vector < UsdGeomXformOp >	GetOrderedXformOps (bool *resetsXformStack) const
USDGEOM_API bool	ClearXformOpOrder () const
	Clears the local transform stack. More...
USDGEOM_API UsdGeomXformOp	MakeMatrixXform () const
USDGEOM_API bool	TransformMightBeTimeVarying () const
USDGEOM_API bool	TransformMightBeTimeVarying (const std::vector< UsdGeomXformOp > &ops) const
USDGEOM_API bool	GetTimeSamples (std::vector< double > *times) const
USDGEOM_API bool	GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const
USDGEOM_API bool	GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const UsdTimeCode time=UsdTimeCode::Default()) const
USDGEOM_API bool	GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const std::vector< UsdGeomXformOp > &ops, const UsdTimeCode time=UsdTimeCode::Default()) const
Public Member Functions inherited from UsdGeomImageable
	UsdGeomImageable (const UsdPrim &prim=UsdPrim())
	UsdGeomImageable (const UsdSchemaBase &schemaObj)
virtual USDGEOM_API	~UsdGeomImageable ()
	Destructor. More...
USDGEOM_API UsdAttribute	GetVisibilityAttr () const
USDGEOM_API UsdAttribute	CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute	GetPurposeAttr () const
USDGEOM_API UsdAttribute	CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdRelationship	GetProxyPrimRel () const
USDGEOM_API UsdRelationship	CreateProxyPrimRel () const
USDGEOM_API void	MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
USDGEOM_API void	MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
USDGEOM_API TfToken	ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const
USDGEOM_API UsdAttribute	GetPurposeVisibilityAttr (const TfToken &purpose=UsdGeomTokens->default_) const
USDGEOM_API TfToken	ComputeEffectiveVisibility (const TfToken &purpose=UsdGeomTokens->default_, const UsdTimeCode &time=UsdTimeCode::Default()) const
USDGEOM_API PurposeInfo	ComputePurposeInfo () const
USDGEOM_API PurposeInfo	ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const
USDGEOM_API TfToken	ComputePurpose () const
USDGEOM_API UsdPrim	ComputeProxyPrim (UsdPrim *renderPrim=NULL) const
USDGEOM_API bool	SetProxyPrim (const UsdPrim &proxy) const
USDGEOM_API bool	SetProxyPrim (const UsdSchemaBase &proxy) const
USDGEOM_API GfBBox3d	ComputeWorldBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
USDGEOM_API GfBBox3d	ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
USDGEOM_API GfBBox3d	ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
USDGEOM_API GfMatrix4d	ComputeLocalToWorldTransform (UsdTimeCode const &time) const
USDGEOM_API GfMatrix4d	ComputeParentToWorldTransform (UsdTimeCode const &time) const
Public Member Functions inherited from UsdTyped
	UsdTyped (const UsdPrim &prim=UsdPrim())
	UsdTyped (const UsdSchemaBase &schemaObj)
virtual USD_API	~UsdTyped ()
	Destructor. More...
Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
bool	IsTyped () const
bool	IsAPISchema () const
	Returns whether this is an API schema or not. More...
bool	IsAppliedAPISchema () const
bool	IsMultipleApplyAPISchema () const
UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is. More...
USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store prim as the held prim. More...
USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by otherSchema. More...
virtual USD_API	~UsdSchemaBase ()
	Destructor. More...
USD_API	operator bool () const
UsdPrim	GetPrim () const
	Return this schema object's held prim. More...
SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath(). More...
USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const

Static Public Member Functions
static USDGEOM_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDGEOM_API UsdGeomGprim	Get (const UsdStagePtr &stage, const SdfPath &path)
Static Public Member Functions inherited from UsdGeomBoundable
static USDGEOM_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDGEOM_API UsdGeomBoundable	Get (const UsdStagePtr &stage, const SdfPath &path)
static USDGEOM_API bool	ComputeExtentFromPlugins (const UsdGeomBoundable &boundable, const UsdTimeCode &time, VtVec3fArray *extent)
static USDGEOM_API bool	ComputeExtentFromPlugins (const UsdGeomBoundable &boundable, const UsdTimeCode &time, const GfMatrix4d &transform, VtVec3fArray *extent)
Static Public Member Functions inherited from UsdGeomXformable
static USDGEOM_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDGEOM_API UsdGeomXformable	Get (const UsdStagePtr &stage, const SdfPath &path)
static USDGEOM_API bool	GetTimeSamples (std::vector< UsdGeomXformOp > const &orderedXformOps, std::vector< double > *times)
static USDGEOM_API bool	GetTimeSamplesInInterval (std::vector< UsdGeomXformOp > const &orderedXformOps, const GfInterval &interval, std::vector< double > *times)
static USDGEOM_API bool	GetLocalTransformation (GfMatrix4d *transform, std::vector< UsdGeomXformOp > const &ops, const UsdTimeCode time)
static USDGEOM_API bool	IsTransformationAffectedByAttrNamed (const TfToken &attrName)
Static Public Member Functions inherited from UsdGeomImageable
static USDGEOM_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDGEOM_API UsdGeomImageable	Get (const UsdStagePtr &stage, const SdfPath &path)
static USDGEOM_API const TfTokenVector &	GetOrderedPurposeTokens ()
Static Public Member Functions inherited from UsdTyped
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USD_API UsdTyped	Get (const UsdStagePtr &stage, const SdfPath &path)
Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
Static Public Attributes inherited from UsdGeomBoundable
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
Static Public Attributes inherited from UsdGeomXformable
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
Static Public Attributes inherited from UsdGeomImageable
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
Static Public Attributes inherited from UsdTyped
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Protected Member Functions
USDGEOM_API UsdSchemaKind	_GetSchemaKind () const override
Protected Member Functions inherited from UsdGeomXformable
USDGEOM_API UsdSchemaKind	_GetSchemaKind () const override
Protected Member Functions inherited from UsdTyped
USD_API bool	_IsCompatible () const override
Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind	_GetSchemaType () const
const TfType &	_GetType () const
USD_API UsdAttribute	_CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const

Friends
class	UsdSchemaRegistry

Detailed Description

Base class for all geometric primitives.

Gprim encodes basic graphical properties such as doubleSided and orientation, and provides primvars for "display color" and "display opacity" that travel with geometry to be used as shader overrides.

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdGeomTokens. So to set an attribute to the value "rightHanded", use UsdGeomTokens->rightHanded as the value.

Definition at line 66 of file gprim.h.

Constructor & Destructor Documentation

UsdGeomGprim::UsdGeomGprim ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a UsdGeomGprim on UsdPrim prim . Equivalent to UsdGeomGprim::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 78 of file gprim.h.

UsdGeomGprim::UsdGeomGprim ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a UsdGeomGprim on the prim held by schemaObj . Should be preferred over UsdGeomGprim(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 86 of file gprim.h.

virtual USDGEOM_API UsdGeomGprim::~UsdGeomGprim ( )

virtual

Destructor.

Member Function Documentation

USDGEOM_API UsdSchemaKind UsdGeomGprim::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also

UsdSchemaKind

Reimplemented from UsdGeomBoundable.

Reimplemented in UsdGeomMesh, UsdGeomNurbsPatch, UsdGeomHermiteCurves, UsdGeomNurbsCurves, UsdGeomPlane, UsdVolVolume, UsdGeomPoints, UsdGeomSphere, and UsdGeomPointBased.

USDGEOM_API UsdAttribute UsdGeomGprim::CreateDisplayColorAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetDisplayColorAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDGEOM_API UsdGeomPrimvar UsdGeomGprim::CreateDisplayColorPrimvar	(	const TfToken &	interpolation = TfToken(),
		int	elementSize = -1
	)		const

Convenience function to create the displayColor primvar, optionally specifying interpolation and elementSize

See Also

CreateDisplayColorAttr(), GetDisplayColorPrimvar()

USDGEOM_API UsdAttribute UsdGeomGprim::CreateDisplayOpacityAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetDisplayOpacityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDGEOM_API UsdGeomPrimvar UsdGeomGprim::CreateDisplayOpacityPrimvar	(	const TfToken &	interpolation = TfToken(),
		int	elementSize = -1
	)		const

Convenience function to create the displayOpacity primvar, optionally specifying interpolation and elementSize

See Also

CreateDisplayOpacityAttr(), GetDisplayOpacityPrimvar()

USDGEOM_API UsdAttribute UsdGeomGprim::CreateDoubleSidedAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetDoubleSidedAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDGEOM_API UsdAttribute UsdGeomGprim::CreateOrientationAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetOrientationAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

static USDGEOM_API UsdGeomGprim UsdGeomGprim::Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Return a UsdGeomGprim holding the prim adhering to this schema at path on stage. If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

UsdGeomGprim(stage->GetPrimAtPath(path));

USDGEOM_API UsdAttribute UsdGeomGprim::GetDisplayColorAttr

(

)

const

It is useful to have an "official" colorSet that can be used as a display or modeling color, even in the absence of any specified shader for a gprim. DisplayColor serves this role; because it is a UsdGeomPrimvar, it can also be used as a gprim override for any shader that consumes a displayColor parameter.

Declaration	color3f[] primvars:displayColor
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Color3fArray

USDGEOM_API UsdGeomPrimvar UsdGeomGprim::GetDisplayColorPrimvar

(

)

const

Convenience function to get the displayColor Attribute as a Primvar.

See Also

GetDisplayColorAttr(), CreateDisplayColorPrimvar()

USDGEOM_API UsdAttribute UsdGeomGprim::GetDisplayOpacityAttr

(

)

const

Companion to displayColor that specifies opacity, broken out as an independent attribute rather than an rgba color, both so that each can be independently overridden, and because shaders rarely consume rgba parameters.

Declaration	float[] primvars:displayOpacity
C++ Type	VtArray<float>
Usd Type	SdfValueTypeNames->FloatArray

USDGEOM_API UsdGeomPrimvar UsdGeomGprim::GetDisplayOpacityPrimvar

(

)

const

Convenience function to get the displayOpacity Attribute as a Primvar.

See Also

GetDisplayOpacityAttr(), CreateDisplayOpacityPrimvar()

USDGEOM_API UsdAttribute UsdGeomGprim::GetDoubleSidedAttr

(

)

const

Although some renderers treat all parametric or polygonal surfaces as if they were effectively laminae with outward-facing normals on both sides, some renderers derive significant optimizations by considering these surfaces to have only a single outward side, typically determined by control-point winding order and/or orientation. By doing so they can perform "backface culling" to avoid drawing the many polygons of most closed surfaces that face away from the viewer.

However, it is often advantageous to model thin objects such as paper and cloth as single, open surfaces that must be viewable from both sides, always. Setting a gprim's doubleSided attribute to true instructs all renderers to disable optimizations such as backface culling for the gprim, and attempt (not all renderers are able to do so, but the USD reference GL renderer always will) to provide forward-facing normals on each side of the surface for lighting calculations.

Declaration	uniform bool doubleSided = 0
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool
Variability	SdfVariabilityUniform

USDGEOM_API UsdAttribute UsdGeomGprim::GetOrientationAttr

(

)

const

Orientation specifies whether the gprim's surface normal should be computed using the right hand rule, or the left hand rule. Please see UsdGeom_WindingOrder for a deeper explanation and generalization of orientation to composed scenes with transformation hierarchies.

Declaration	uniform token orientation = "rightHanded"
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	rightHanded, leftHanded

static USDGEOM_API const TfTokenVector& UsdGeomGprim::GetSchemaAttributeNames ( bool  includeInherited = true )

static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

Friends And Related Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 125 of file gprim.h.

Member Data Documentation

const UsdSchemaKind UsdGeomGprim::schemaKind = UsdSchemaKind::AbstractTyped

static

Compile time constant representing what kind of schema this class is.

See Also

UsdSchemaKind

Definition at line 72 of file gprim.h.

---

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

• pxr/usd/usdGeom/gprim.h